From: Thomas Wood <thomas.wood@intel.com>
To: intel-gfx@lists.freedesktop.org
Subject: [i-g-t 3/7] README: update the section on modifying and rebuilding documentation
Date: Tue, 10 Jun 2014 15:30:53 +0100 [thread overview]
Message-ID: <1402410657-4768-3-git-send-email-thomas.wood@intel.com> (raw)
In-Reply-To: <1402410657-4768-1-git-send-email-thomas.wood@intel.com>
Signed-off-by: Thomas Wood <thomas.wood@intel.com>
---
README | 12 +++++-------
1 file changed, 5 insertions(+), 7 deletions(-)
diff --git a/README b/README
index cfa186d..5e98565 100644
--- a/README
+++ b/README
@@ -108,16 +108,14 @@ docs/
reference documenation in docs/reference/ You need to have the gtk doc
tools installed to generate this API documentation.
- Note that the currrent gtk-docs integration sucks a bit wrt regenerating
- the html files. You need at least
+ To regenerate the html files when updating documentation, use:
$ make clean -C docs && make -C docs
- to regenerate them on any change. If you've added/changed/removed a
- symbol or anything else that changes the overall structure or indexes,
- you need a full rebuild:
-
- $ git clean -dfx && ./autogen.sh --enable-gtk-doc && make -C docs
+ If you've added/changed/removed a symbol or anything else that changes
+ the overall structure or indexes, this needs to be reflected in
+ intel-gpu-tools-sections.txt. Entirely new sections will also need to be
+ added to intel-gpu-tools-docs.xml in the appropriate place.
DEPENDENCIES
This is a non-exchaustive list of package dependencies required for
--
1.9.3
next prev parent reply other threads:[~2014-06-10 14:31 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-06-10 14:30 [i-g-t 1/7] README: update piglit instructions Thomas Wood
2014-06-10 14:30 ` [i-g-t 2/7] lib: remove /** from comments that are not API documentation Thomas Wood
2014-06-10 14:30 ` Thomas Wood [this message]
2014-06-10 14:38 ` [i-g-t 3/7] README: update the section on modifying and rebuilding documentation Daniel Vetter
2014-06-11 10:33 ` Thomas Wood
2014-06-10 14:30 ` [i-g-t 4/7] docs: add the sections file Thomas Wood
2014-06-10 14:40 ` Daniel Vetter
2014-06-11 10:35 ` Thomas Wood
2014-06-11 11:56 ` Daniel Vetter
2014-06-11 14:49 ` [PATCH i-g-t] docs: always rebuild " Thomas Wood
2014-06-10 14:30 ` [i-g-t 5/7] gitignore: add missing files and keep lists sorted Thomas Wood
2014-06-10 14:30 ` [i-g-t 6/7] lib: various documentation fixes Thomas Wood
2014-06-10 14:44 ` Daniel Vetter
2014-06-10 14:30 ` [i-g-t 7/7] docs: add missing sections to intel-gpu-tools-docs.xml Thomas Wood
2014-06-10 14:47 ` Daniel Vetter
2014-06-11 10:36 ` Thomas Wood
2014-06-11 10:53 ` [PATCH i-g-t] docs: add private headers to IGNORE_HFILES Thomas Wood
2014-06-11 11:57 ` Daniel Vetter
2014-06-10 14:37 ` [i-g-t 1/7] README: update piglit instructions Daniel Vetter
2014-06-10 15:06 ` Thomas Wood
2014-06-10 15:28 ` Daniel Vetter
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1402410657-4768-3-git-send-email-thomas.wood@intel.com \
--to=thomas.wood@intel.com \
--cc=intel-gfx@lists.freedesktop.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox