From: "Heba Waly via GitGitGadget" <gitgitgadget@gmail.com> To: git@vger.kernel.org Cc: Heba Waly <heba.waly@gmail.com>, Junio C Hamano <gitster@pobox.com>, Heba Waly <heba.waly@gmail.com> Subject: [PATCH v5 21/21] api-index: remove api doc index files Date: Sun, 17 Nov 2019 21:05:00 +0000 [thread overview] Message-ID: <3771f7e2cb2187e8faa8e6f4f8fd585a20cbb0ba.1574024701.git.gitgitgadget@gmail.com> (raw) In-Reply-To: <pull.434.v5.git.1574024700.gitgitgadget@gmail.com> From: Heba Waly <heba.waly@gmail.com> 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 <heba.waly@gmail.com> --- 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 -- gitgitgadget
prev parent reply other threads:[~2019-11-17 21:05 UTC|newest] Thread overview: 123+ messages / expand[flat|nested] mbox.gz Atom feed top 2019-10-29 10:00 [PATCH 00/10] [Outreachy] Move doc to header files Heba Waly via GitGitGadget 2019-10-29 10:00 ` [PATCH 01/10] diff: move doc to diff.h and diffcore.h Heba Waly via GitGitGadget 2019-10-29 10:00 ` [PATCH 02/10] dir: move doc to dir.h Heba Waly via GitGitGadget 2019-10-29 10:00 ` [PATCH 03/10] graph: move doc to graph.h and graph.c Heba Waly via GitGitGadget 2019-10-29 10:00 ` [PATCH 04/10] merge: move doc to ll-merge.h Heba Waly via GitGitGadget 2019-10-30 22:09 ` Elijah Newren 2019-10-31 19:35 ` Heba Waly 2019-11-02 4:28 ` Junio C Hamano 2019-10-29 10:00 ` [PATCH 05/10] sha1-array: move doc to sha1-array.h Heba Waly via GitGitGadget 2019-10-29 10:00 ` [PATCH 06/10] remote: move doc to remote.h and refspec.h Heba Waly via GitGitGadget 2019-10-29 10:00 ` [PATCH 07/10] refs: move doc to refs.h Heba Waly via GitGitGadget 2019-10-29 10:00 ` [PATCH 08/10] attr: move doc to attr.h Heba Waly via GitGitGadget 2019-10-29 10:00 ` [PATCH 09/10] revision: move doc to revision.h Heba Waly via GitGitGadget 2019-10-29 23:57 ` Emily Shaffer 2019-10-29 10:00 ` [PATCH 10/10] pathspec: move doc to pathspec.h Heba Waly via GitGitGadget 2019-11-06 9:59 ` [PATCH v2 00/20] [Outreachy] Move doc to header files Heba Waly via GitGitGadget 2019-11-06 9:59 ` [PATCH v2 01/20] diff: move doc to diff.h and diffcore.h Heba Waly via GitGitGadget 2019-11-06 9:59 ` [PATCH v2 02/20] dir: move doc to dir.h Heba Waly via GitGitGadget 2019-11-07 1:16 ` Emily Shaffer 2019-11-11 0:20 ` Heba Waly 2019-11-06 9:59 ` [PATCH v2 03/20] graph: move doc to graph.h and graph.c Heba Waly via GitGitGadget 2019-11-06 9:59 ` [PATCH v2 04/20] merge: move doc to ll-merge.h Heba Waly via GitGitGadget 2019-11-06 9:59 ` [PATCH v2 05/20] sha1-array: move doc to sha1-array.h Heba Waly via GitGitGadget 2019-11-06 9:59 ` [PATCH v2 06/20] remote: move doc to remote.h and refspec.h Heba Waly via GitGitGadget 2019-11-06 9:59 ` [PATCH v2 07/20] refs: move doc to refs.h Heba Waly via GitGitGadget 2019-11-06 9:59 ` [PATCH v2 08/20] attr: move doc to attr.h Heba Waly via GitGitGadget 2019-11-06 9:59 ` [PATCH v2 09/20] revision: move doc to revision.h Heba Waly via GitGitGadget 2019-11-06 9:59 ` [PATCH v2 10/20] pathspec: move doc to pathspec.h Heba Waly via GitGitGadget 2019-11-07 1:26 ` Emily Shaffer 2019-11-10 1:40 ` Heba Waly 2019-11-06 9:59 ` [PATCH v2 11/20] sigchain: move doc to sigchain.h Heba Waly via GitGitGadget 2019-11-06 22:03 ` Emily Shaffer 2019-11-11 1:04 ` Heba Waly 2019-11-06 9:59 ` [PATCH v2 12/20] cache: move doc to cache.h Heba Waly via GitGitGadget 2019-11-06 22:04 ` Emily Shaffer 2019-11-06 9:59 ` [PATCH v2 13/20] argv-array: move doc to argv-array.h Heba Waly via GitGitGadget 2019-11-06 9:59 ` [PATCH v2 14/20] credential: move doc to credential.h Heba Waly via GitGitGadget 2019-11-06 9:59 ` [PATCH v2 15/20] parse-options: move doc to parse-options.h Heba Waly via GitGitGadget 2019-11-11 2:45 ` Junio C Hamano 2019-11-11 21:38 ` Heba Waly 2019-11-12 5:57 ` Junio C Hamano 2019-11-15 9:55 ` Heba Waly 2019-11-15 11:37 ` Junio C Hamano 2019-11-15 23:28 ` Emily Shaffer 2019-11-17 11:34 ` Heba Waly 2019-11-06 9:59 ` [PATCH v2 16/20] run-command: move doc to run-command.h Heba Waly via GitGitGadget 2019-11-06 9:59 ` [PATCH v2 17/20] trace: move doc to trace.h Heba Waly via GitGitGadget 2019-11-07 1:32 ` Emily Shaffer 2019-11-06 9:59 ` [PATCH v2 18/20] tree-walk: move doc to tree-walk.h Heba Waly via GitGitGadget 2019-11-06 9:59 ` [PATCH v2 19/20] submodule-config: move doc to submodule-config.h Heba Waly via GitGitGadget 2019-11-06 9:59 ` [PATCH v2 20/20] trace2: move doc to trace2.h Heba Waly via GitGitGadget 2019-11-11 21:27 ` [PATCH v3 00/21] [Outreachy] Move doc to header files Heba Waly via GitGitGadget 2019-11-11 21:27 ` [PATCH v3 01/21] diff: move doc to diff.h and diffcore.h Heba Waly via GitGitGadget 2019-11-12 7:20 ` Junio C Hamano 2019-11-14 12:22 ` Heba Waly 2019-11-11 21:27 ` [PATCH v3 02/21] dir: move doc to dir.h Heba Waly via GitGitGadget 2019-11-11 21:27 ` [PATCH v3 03/21] graph: move doc to graph.h and graph.c Heba Waly via GitGitGadget 2019-11-11 21:27 ` [PATCH v3 04/21] merge: move doc to ll-merge.h Heba Waly via GitGitGadget 2019-11-11 21:27 ` [PATCH v3 05/21] sha1-array: move doc to sha1-array.h Heba Waly via GitGitGadget 2019-11-11 21:27 ` [PATCH v3 06/21] remote: move doc to remote.h and refspec.h Heba Waly via GitGitGadget 2019-11-11 21:27 ` [PATCH v3 07/21] refs: move doc to refs.h Heba Waly via GitGitGadget 2019-11-11 21:27 ` [PATCH v3 08/21] attr: move doc to attr.h Heba Waly via GitGitGadget 2019-11-11 21:27 ` [PATCH v3 09/21] revision: move doc to revision.h Heba Waly via GitGitGadget 2019-11-11 21:27 ` [PATCH v3 10/21] pathspec: move doc to pathspec.h Heba Waly via GitGitGadget 2019-11-11 21:27 ` [PATCH v3 11/21] sigchain: move doc to sigchain.h Heba Waly via GitGitGadget 2019-11-11 21:27 ` [PATCH v3 12/21] cache: move doc to cache.h Heba Waly via GitGitGadget 2019-11-12 7:05 ` Junio C Hamano 2019-11-14 10:14 ` Heba Waly 2019-11-11 21:27 ` [PATCH v3 13/21] argv-array: move doc to argv-array.h Heba Waly via GitGitGadget 2019-11-11 21:27 ` [PATCH v3 14/21] credential: move doc to credential.h Heba Waly via GitGitGadget 2019-11-11 21:27 ` [PATCH v3 15/21] parse-options: move doc to parse-options.h Heba Waly via GitGitGadget 2019-11-11 21:27 ` [PATCH v3 16/21] run-command: move doc to run-command.h Heba Waly via GitGitGadget 2019-11-11 21:28 ` [PATCH v3 17/21] trace: move doc to trace.h Heba Waly via GitGitGadget 2019-11-11 21:28 ` [PATCH v3 18/21] tree-walk: move doc to tree-walk.h Heba Waly via GitGitGadget 2019-11-11 21:28 ` [PATCH v3 19/21] submodule-config: move doc to submodule-config.h Heba Waly via GitGitGadget 2019-11-11 21:28 ` [PATCH v3 20/21] trace2: move doc to trace2.h Heba Waly via GitGitGadget 2019-11-12 7:02 ` Junio C Hamano 2019-11-14 10:30 ` Heba Waly 2019-11-11 21:28 ` [PATCH v3 21/21] api-index: remove api doc index files Heba Waly via GitGitGadget 2019-11-15 9:53 ` [PATCH v4 00/21] [Outreachy] Move doc to header files Heba Waly via GitGitGadget 2019-11-15 9:53 ` [PATCH v4 01/21] diff: move doc to diff.h and diffcore.h Heba Waly via GitGitGadget 2019-11-15 9:53 ` [PATCH v4 02/21] dir: move doc to dir.h Heba Waly via GitGitGadget 2019-11-15 9:53 ` [PATCH v4 03/21] graph: move doc to graph.h and graph.c Heba Waly via GitGitGadget 2019-11-15 9:53 ` [PATCH v4 04/21] merge: move doc to ll-merge.h Heba Waly via GitGitGadget 2019-11-15 9:53 ` [PATCH v4 05/21] sha1-array: move doc to sha1-array.h Heba Waly via GitGitGadget 2019-11-15 9:53 ` [PATCH v4 06/21] remote: move doc to remote.h and refspec.h Heba Waly via GitGitGadget 2019-11-15 9:53 ` [PATCH v4 07/21] refs: move doc to refs.h Heba Waly via GitGitGadget 2019-11-15 9:53 ` [PATCH v4 08/21] attr: move doc to attr.h Heba Waly via GitGitGadget 2019-11-15 9:53 ` [PATCH v4 09/21] revision: move doc to revision.h Heba Waly via GitGitGadget 2019-11-15 9:53 ` [PATCH v4 10/21] pathspec: move doc to pathspec.h Heba Waly via GitGitGadget 2019-11-15 9:53 ` [PATCH v4 11/21] sigchain: move doc to sigchain.h Heba Waly via GitGitGadget 2019-11-15 9:53 ` [PATCH v4 12/21] cache: move doc to cache.h Heba Waly via GitGitGadget 2019-11-15 9:53 ` [PATCH v4 13/21] argv-array: move doc to argv-array.h Heba Waly via GitGitGadget 2019-11-15 9:53 ` [PATCH v4 14/21] credential: move doc to credential.h Heba Waly via GitGitGadget 2019-11-15 9:53 ` [PATCH v4 15/21] parse-options: move doc to parse-options.h Heba Waly via GitGitGadget 2019-11-15 9:53 ` [PATCH v4 16/21] run-command: move doc to run-command.h Heba Waly via GitGitGadget 2019-11-15 9:53 ` [PATCH v4 17/21] trace: move doc to trace.h Heba Waly via GitGitGadget 2019-11-15 9:53 ` [PATCH v4 18/21] tree-walk: move doc to tree-walk.h Heba Waly via GitGitGadget 2019-11-15 9:53 ` [PATCH v4 19/21] submodule-config: move doc to submodule-config.h Heba Waly via GitGitGadget 2019-11-15 9:53 ` [PATCH v4 20/21] trace2: move doc to trace2.h Heba Waly via GitGitGadget 2019-11-15 9:53 ` [PATCH v4 21/21] api-index: remove api doc index files Heba Waly via GitGitGadget 2019-11-17 21:04 ` [PATCH v5 00/21] [Outreachy] Move doc to header files Heba Waly via GitGitGadget 2019-11-17 21:04 ` [PATCH v5 01/21] diff: move doc to diff.h and diffcore.h Heba Waly via GitGitGadget 2019-11-17 21:04 ` [PATCH v5 02/21] dir: move doc to dir.h Heba Waly via GitGitGadget 2019-11-17 21:04 ` [PATCH v5 03/21] graph: move doc to graph.h and graph.c Heba Waly via GitGitGadget 2019-11-17 21:04 ` [PATCH v5 04/21] merge: move doc to ll-merge.h Heba Waly via GitGitGadget 2019-11-17 21:04 ` [PATCH v5 05/21] sha1-array: move doc to sha1-array.h Heba Waly via GitGitGadget 2019-11-17 21:04 ` [PATCH v5 06/21] remote: move doc to remote.h and refspec.h Heba Waly via GitGitGadget 2019-11-17 21:04 ` [PATCH v5 07/21] refs: move doc to refs.h Heba Waly via GitGitGadget 2019-11-17 21:04 ` [PATCH v5 08/21] attr: move doc to attr.h Heba Waly via GitGitGadget 2019-11-17 21:04 ` [PATCH v5 09/21] revision: move doc to revision.h Heba Waly via GitGitGadget 2019-11-17 21:04 ` [PATCH v5 10/21] pathspec: move doc to pathspec.h Heba Waly via GitGitGadget 2019-11-17 21:04 ` [PATCH v5 11/21] sigchain: move doc to sigchain.h Heba Waly via GitGitGadget 2019-11-17 21:04 ` [PATCH v5 12/21] cache: move doc to cache.h Heba Waly via GitGitGadget 2019-11-17 21:04 ` [PATCH v5 13/21] argv-array: move doc to argv-array.h Heba Waly via GitGitGadget 2019-11-17 21:04 ` [PATCH v5 14/21] credential: move doc to credential.h Heba Waly via GitGitGadget 2019-11-17 21:04 ` [PATCH v5 15/21] parse-options: add link to doc file in parse-options.h Heba Waly via GitGitGadget 2019-11-17 21:04 ` [PATCH v5 16/21] run-command: move doc to run-command.h Heba Waly via GitGitGadget 2019-11-17 21:04 ` [PATCH v5 17/21] trace: move doc to trace.h Heba Waly via GitGitGadget 2019-11-17 21:04 ` [PATCH v5 18/21] tree-walk: move doc to tree-walk.h Heba Waly via GitGitGadget 2019-11-17 21:04 ` [PATCH v5 19/21] submodule-config: move doc to submodule-config.h Heba Waly via GitGitGadget 2019-11-17 21:04 ` [PATCH v5 20/21] trace2: move doc to trace2.h Heba Waly via GitGitGadget 2019-11-17 21:05 ` Heba Waly via GitGitGadget [this message]
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=3771f7e2cb2187e8faa8e6f4f8fd585a20cbb0ba.1574024701.git.gitgitgadget@gmail.com \ --to=gitgitgadget@gmail.com \ --cc=git@vger.kernel.org \ --cc=gitster@pobox.com \ --cc=heba.waly@gmail.com \ --subject='Re: [PATCH v5 21/21] api-index: remove api doc index files' \ /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
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for NNTP newsgroup(s).