From patchwork Mon Nov 11 21:28:04 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Johannes Schindelin via GitGitGadget X-Patchwork-Id: 11237867 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id DE54413BD for ; Mon, 11 Nov 2019 21:28:32 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id BC7232084F for ; Mon, 11 Nov 2019 21:28:32 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="iXfEIojU" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727398AbfKKV2b (ORCPT ); Mon, 11 Nov 2019 16:28:31 -0500 Received: from mail-wm1-f68.google.com ([209.85.128.68]:53324 "EHLO mail-wm1-f68.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727347AbfKKV2Z (ORCPT ); Mon, 11 Nov 2019 16:28:25 -0500 Received: by mail-wm1-f68.google.com with SMTP id u18so857236wmc.3 for ; Mon, 11 Nov 2019 13:28:23 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=message-id:in-reply-to:references:from:date:subject:fcc :content-transfer-encoding:mime-version:to:cc; bh=gnKUVJ1lm2HEd10kicC0YvBZsIDgxI2dYQImyP93oT8=; b=iXfEIojU+VnnoZpvzxBBgqnC/aHPzMnRNFiapY9Y8ArhJHwz5TDV5t12rsVMefqxWl ZsvHtQI+qMycUTba0t1PwE9Po2HaO3o/FnZ0dmGQO2aj18SWtA9WV/hmN7NMk/YTGqRZ OJfpiKtmcHWWJCzgpVPIMTl6r3ISFUpc9IroljqH4ADm1m13odo+3PmT1emEo5D3qFhZ Gdeb8rdKf7Ha0YIOXpG82EHgsZ/jXLr8X9aC6GCghpVLbLUjAAz4m2bC0Zg7OxZBWqAu 1tTtG0Gx6ORA3Ly3Z8bjwF4aUNGRcJ+EXxbq4bTRN7L/UQAINs4zxX4KXcm211ZpdwBY SDMQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:message-id:in-reply-to:references:from:date :subject:fcc:content-transfer-encoding:mime-version:to:cc; bh=gnKUVJ1lm2HEd10kicC0YvBZsIDgxI2dYQImyP93oT8=; b=Rt3+ZdtdLLrYdZ8BAjD0yX++OeyxtwKsbaW4ZHkZv3gN7IzXLvaQJuN56elwiYf3FB 4QHuO67uci0KmMoxmk1tghu8ZxLHU8hOI7EMkXv5TVVTu08G/o2mVlSSeLxWa8bWk/Vq sthUNiSRcVx1mPRZDFKy4ybAZQ77fmJQMsqsECRpu2LfZhp4vBT7/bXV3f44FeQn4Isb N1ba3EVPQtxyY8/mKxHRKpTERLGitaUZKddBbAb5tY7ov1d8o+255lvqfyEiSMqi9kdp Wvgw3FXR8Vt/Vwpcxku+5NcGbrk3r8RtUMlkvJynvGOGR3lvtQ5EHn4UPdLx6Y5AB/Ug EQWQ== X-Gm-Message-State: APjAAAUl9AS64hzcR5EYkAzMxRsLiHt5X9ATIiE7Z3VgQ6KxXHAe5LXj mKV3fiGL7GMTJkcRTZZCWRi2KQAR X-Google-Smtp-Source: APXvYqyme72ft/Ws8qbFQ1ZyHd86kODzz2xfEt4y9hcVLmi0j14umwpe3ANdor8gWyssa1TcWWwQ5w== X-Received: by 2002:a1c:814b:: with SMTP id c72mr888949wmd.167.1573507702308; Mon, 11 Nov 2019 13:28:22 -0800 (PST) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id m15sm18895118wrq.97.2019.11.11.13.28.21 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 11 Nov 2019 13:28:21 -0800 (PST) Message-Id: In-Reply-To: References: From: "Heba Waly via GitGitGadget" Date: Mon, 11 Nov 2019 21:28:04 +0000 Subject: [PATCH v3 21/21] api-index: remove api doc index files Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: Heba Waly , Junio C Hamano , Heba Waly Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Heba Waly Remove both api-index.txt and api-index-skel.txt as the API documentation is being moved to the header files, so the index is not needed anymore because the doc files (Documentation/technical/api-*.txt) will be gone. Make changes to Documentation/Makefile accordingly. Signed-off-by: Heba Waly --- Documentation/Makefile | 11 +++------ Documentation/git.txt | 3 --- Documentation/technical/.gitignore | 1 - Documentation/technical/api-index-skel.txt | 13 ---------- Documentation/technical/api-index.sh | 28 ---------------------- 5 files changed, 3 insertions(+), 53 deletions(-) delete mode 100644 Documentation/technical/.gitignore delete mode 100644 Documentation/technical/api-index-skel.txt delete mode 100755 Documentation/technical/api-index.sh diff --git a/Documentation/Makefile b/Documentation/Makefile index 8fe829cc1b..28d8f68c9d 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -73,7 +73,7 @@ SP_ARTICLES += howto/rebuild-from-update-hook SP_ARTICLES += howto/rebase-from-internal-branch SP_ARTICLES += howto/keep-canonical-history-correct SP_ARTICLES += howto/maintain-git -API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technical/api-index.txt, $(wildcard technical/api-*.txt))) +API_DOCS = $(patsubst %.txt,%,$(wildcard technical/api-*.txt)) SP_ARTICLES += $(API_DOCS) TECH_DOCS += MyFirstContribution @@ -97,7 +97,6 @@ TECH_DOCS += technical/shallow TECH_DOCS += technical/signature-format TECH_DOCS += technical/trivial-merge SP_ARTICLES += $(TECH_DOCS) -SP_ARTICLES += technical/api-index ARTICLES_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES)) HTML_FILTER ?= $(ARTICLES_HTML) $(OBSOLETE_HTML) @@ -353,7 +352,7 @@ clean: $(RM) *.texi *.texi+ *.texi++ git.info gitman.info $(RM) *.pdf $(RM) howto-index.txt howto/*.html doc.dep - $(RM) technical/*.html technical/api-index.txt + $(RM) technical/*.html $(RM) SubmittingPatches.txt $(RM) $(cmds_txt) $(mergetools_txt) *.made $(RM) manpage-base-url.xsl @@ -386,12 +385,8 @@ user-manual.xml: user-manual.txt user-manual.conf asciidoctor-extensions.rb GIT- $(TXT_TO_XML) -d book -o $@+ $< && \ mv $@+ $@ -technical/api-index.txt: technical/api-index-skel.txt \ - technical/api-index.sh $(patsubst %,%.txt,$(API_DOCS)) - $(QUIET_GEN)cd technical && '$(SHELL_PATH_SQ)' ./api-index.sh - technical/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../ -$(patsubst %,%.html,$(API_DOCS) technical/api-index $(TECH_DOCS)): %.html : %.txt \ +$(patsubst %,%.html,$(API_DOCS) $(TECH_DOCS)): %.html : %.txt \ asciidoc.conf GIT-ASCIIDOCFLAGS $(QUIET_ASCIIDOC)$(TXT_TO_HTML) $*.txt diff --git a/Documentation/git.txt b/Documentation/git.txt index 9b82564d1a..0fdd93ac95 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -904,9 +904,6 @@ See linkgit:gitworkflows[7] for an overview of recommended workflows. See also the link:howto-index.html[howto] documents for some useful examples. -The internals are documented in the -link:technical/api-index.html[Git API documentation]. - Users migrating from CVS may also want to read linkgit:gitcvs-migration[7]. diff --git a/Documentation/technical/.gitignore b/Documentation/technical/.gitignore deleted file mode 100644 index 8aa891daee..0000000000 --- a/Documentation/technical/.gitignore +++ /dev/null @@ -1 +0,0 @@ -api-index.txt diff --git a/Documentation/technical/api-index-skel.txt b/Documentation/technical/api-index-skel.txt deleted file mode 100644 index eda8c195c1..0000000000 --- a/Documentation/technical/api-index-skel.txt +++ /dev/null @@ -1,13 +0,0 @@ -Git API Documents -================= - -Git has grown a set of internal API over time. This collection -documents them. - -//////////////////////////////////////////////////////////////// -// table of contents begin -//////////////////////////////////////////////////////////////// - -//////////////////////////////////////////////////////////////// -// table of contents end -//////////////////////////////////////////////////////////////// diff --git a/Documentation/technical/api-index.sh b/Documentation/technical/api-index.sh deleted file mode 100755 index 9c3f4131b8..0000000000 --- a/Documentation/technical/api-index.sh +++ /dev/null @@ -1,28 +0,0 @@ -#!/bin/sh - -( - c=//////////////////////////////////////////////////////////////// - skel=api-index-skel.txt - sed -e '/^\/\/ table of contents begin/q' "$skel" - echo "$c" - - ls api-*.txt | - while read filename - do - case "$filename" in - api-index-skel.txt | api-index.txt) continue ;; - esac - title=$(sed -e 1q "$filename") - html=${filename%.txt}.html - echo "* link:$html[$title]" - done - echo "$c" - sed -n -e '/^\/\/ table of contents end/,$p' "$skel" -) >api-index.txt+ - -if test -f api-index.txt && cmp api-index.txt api-index.txt+ >/dev/null -then - rm -f api-index.txt+ -else - mv api-index.txt+ api-index.txt -fi