From mboxrd@z Thu Jan 1 00:00:00 1970 From: Daniel Vetter Subject: Re: [i-g-t 3/7] README: update the section on modifying and rebuilding documentation Date: Tue, 10 Jun 2014 16:38:37 +0200 Message-ID: <20140610143837.GU5821@phenom.ffwll.local> References: <1402410657-4768-1-git-send-email-thomas.wood@intel.com> <1402410657-4768-3-git-send-email-thomas.wood@intel.com> Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Return-path: Received: from mail-wg0-f48.google.com (mail-wg0-f48.google.com [74.125.82.48]) by gabe.freedesktop.org (Postfix) with ESMTP id F37826E680 for ; Tue, 10 Jun 2014 07:38:42 -0700 (PDT) Received: by mail-wg0-f48.google.com with SMTP id n12so7314412wgh.19 for ; Tue, 10 Jun 2014 07:38:42 -0700 (PDT) Content-Disposition: inline In-Reply-To: <1402410657-4768-3-git-send-email-thomas.wood@intel.com> List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: intel-gfx-bounces@lists.freedesktop.org Sender: "Intel-gfx" To: Thomas Wood Cc: intel-gfx@lists.freedesktop.org List-Id: intel-gfx@lists.freedesktop.org On Tue, Jun 10, 2014 at 03:30:53PM +0100, Thomas Wood wrote: > Signed-off-by: Thomas Wood > --- > 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 This is still requried afaik when you add new .c/.h files with api docs in them. -Daniel > + 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@lists.freedesktop.org > http://lists.freedesktop.org/mailman/listinfo/intel-gfx -- Daniel Vetter Software Engineer, Intel Corporation +41 (0) 79 365 57 48 - http://blog.ffwll.ch