From patchwork Tue Jun 10 14:30:53 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Thomas Wood X-Patchwork-Id: 4329201 Return-Path: X-Original-To: patchwork-intel-gfx@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork2.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.19.201]) by patchwork2.web.kernel.org (Postfix) with ESMTP id A4FF6BEECB for ; Tue, 10 Jun 2014 14:31:10 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id A21A9202BE for ; Tue, 10 Jun 2014 14:31:09 +0000 (UTC) Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) by mail.kernel.org (Postfix) with ESMTP id 416CA202DD for ; Tue, 10 Jun 2014 14:31:08 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 640DF6E6B0; Tue, 10 Jun 2014 07:31:07 -0700 (PDT) X-Original-To: intel-gfx@lists.freedesktop.org Delivered-To: intel-gfx@lists.freedesktop.org Received: from mail-wg0-f48.google.com (mail-wg0-f48.google.com [74.125.82.48]) by gabe.freedesktop.org (Postfix) with ESMTP id E7EB96E23A for ; Tue, 10 Jun 2014 07:31:05 -0700 (PDT) Received: by mail-wg0-f48.google.com with SMTP id n12so7329044wgh.7 for ; Tue, 10 Jun 2014 07:31:05 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references; bh=CEtVDpXylpbN9dlz5ypFuZ/ebkE0qLf24/gHQz1guUA=; b=HCu3F+ki5IQYmZD3ffRQqdSJzGgwhvQSl+07qTaa0/pwjDtkIIQOLszAblxN/Y72eQ qf0tNOfIl/2i1KzD8DUwQw4oGTcLFJihaFtJom0cCKlaDCKOLB62KUdthXDllf6Jq7iT s8vvvsVaJZEpm0WYlNzcVp+BCkDOGvzw/93ammUM7VUhp6HjiTxs5mIy1ab71jPxz+SB IUvtEo/Vm6oFwOV03w7CAEbB4VSdWLl1y95TabPUr5lUd/yLqwos3fqNey5nK0krbuqE 5TRDvWmWYI41CU17gsjN3RBcqag2n4UKMSxiGtiTmRAcWLsR+20PuNkw3FXcNzlUaBss qayA== X-Gm-Message-State: ALoCoQmGia2L1KMgxB3PkcIGvpaA17LoAoJrCUzlsDhfzouXn5yrjARWPoPbQhGzwYpX8Zc3sSOP X-Received: by 10.180.183.131 with SMTP id em3mr30059419wic.56.1402410662274; Tue, 10 Jun 2014 07:31:02 -0700 (PDT) Received: from pistachio.icx.intel.com ([83.217.123.106]) by mx.google.com with ESMTPSA id ci16sm379523wjb.5.2014.06.10.07.31.01 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 10 Jun 2014 07:31:01 -0700 (PDT) From: Thomas Wood To: intel-gfx@lists.freedesktop.org Date: Tue, 10 Jun 2014 15:30:53 +0100 Message-Id: <1402410657-4768-3-git-send-email-thomas.wood@intel.com> X-Mailer: git-send-email 1.9.3 In-Reply-To: <1402410657-4768-1-git-send-email-thomas.wood@intel.com> References: <1402410657-4768-1-git-send-email-thomas.wood@intel.com> Subject: [Intel-gfx] [i-g-t 3/7] README: update the section on modifying and rebuilding documentation X-BeenThere: intel-gfx@lists.freedesktop.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: Intel graphics driver community testing & development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: intel-gfx-bounces@lists.freedesktop.org Sender: "Intel-gfx" X-Spam-Status: No, score=-4.8 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_MED, RP_MATCHES_RCVD, UNPARSEABLE_RELAY autolearn=unavailable version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on mail.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP 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 + 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