]> granicus.if.org Git - check/commitdiff
Add information about updating generated documentation for website
authorBranden Archer <brarcher@lexmark.com>
Thu, 24 Dec 2015 23:46:14 +0000 (18:46 -0500)
committerBranden Archer <brarcher@lexmark.com>
Thu, 24 Dec 2015 23:46:14 +0000 (18:46 -0500)
HACKING

diff --git a/HACKING b/HACKING
index d2a1f2246ab4d43dbd234eebc9a08891cb6b3b0f..ddbccfa01c492ebe7a66102c8042daa4e1dccaf7 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -115,6 +115,28 @@ the gh-pages branch in the Check git repository. To update
 the website, merge the contents of the master branch into
 the gh-pages branch.
 
+To update the generated documentation for the website:
+
+$ git remote -v
+github  https://github.com/libcheck/check.git (fetch)
+github  https://github.com/libcheck/check.git (push)
+$ git fetch github
+$ git checkout github/gh-pages -b gh-pages
+Branch gh-pages set up to track remote branch gh-pages from github.
+Switched to a new branch 'gh-pages'
+$ git rebase github/master
+First, rewinding head to replay your work on top of it...
+Fast-forwarded gh-pages to github/master.
+$ autoreconf -i
+$ ./configure
+$ make clean
+$ make
+$ make doc/check_html
+$ make doc/doxygen
+$ git add doc
+$ git commit -m “Update documentation”
+$ git push github gh-pages:gh-pages
+
 
 Automatic building of pull requests
 ===============