[i-g-t 3/7] README: update the section on modifying and rebuilding documentation

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Signed-off-by: Thomas Wood <thomas.wood@xxxxxxxxx>
---
 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

_______________________________________________
Intel-gfx mailing list
Intel-gfx@xxxxxxxxxxxxxxxxxxxxx
http://lists.freedesktop.org/mailman/listinfo/intel-gfx




[Index of Archives]     [Linux USB Devel]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]
  Powered by Linux