{"thread":{"id":"52201","subject":"[PATCH 0/1] [Outreachy] doc: remove api-index","startedAt":"2019-11-06T12:48:35Z","lastAt":"2019-11-10T01:06:55Z","messageCount":4,"participants":["Heba Waly via GitGitGadget","Junio C Hamano","Heba Waly"],"isPatch":true,"patchVersion":1,"patchTotal":1},"messages":[{"id":"385590","messageId":"pull.456.git.1573044509.gitgitgadget@gmail.com","threadId":"52201","inReplyTo":null,"subject":"[PATCH 0/1] [Outreachy] doc: remove api-index","fromName":"Heba Waly via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2019-11-06T12:48:28Z","receivedAt":"2019-11-06T12:48:35Z","isPatch":true,"sender":{"key":"heba.waly@gmail.com","avatar":"https://avatars.githubusercontent.com/u/1539076?v=4"},"body":"Remove both api-index.txt and api-index-skel.txt as the API documentation is\nbeing moved to the header files, so the index is not needed anymore because\nthe doc files (Documentation/technical/api-*.txt) will be gone.\n\nMake changes to Documentation/Makefile accordingly.\n\nSigned-off-by: Heba Waly heba.waly@gmail.com [heba.waly@gmail.com]\n\nHeba Waly (1):\n api-index: remove api doc index files\n\n Documentation/Makefile | 11 +++------\n Documentation/git.txt | 3 ---\n Documentation/technical/.gitignore | 1 -\n Documentation/technical/api-index-skel.txt | 13 ----------\n Documentation/technical/api-index.sh | 28 ----------------------\n 5 files changed, 3 insertions(+), 53 deletions(-)\n delete mode 100644 Documentation/technical/.gitignore\n delete mode 100644 Documentation/technical/api-index-skel.txt\n delete mode 100755 Documentation/technical/api-index.sh\n\n\nbase-commit: da72936f544fec5a335e66432610e4cef4430991\nPublished-As: https://github.com/gitgitgadget/git/releases/tag/pr-456%2FHebaWaly%2Fremove-api-index-v1\nFetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-456/HebaWaly/remove-api-index-v1\nPull-Request: https://github.com/gitgitgadget/git/pull/456\n-- \ngitgitgadget\n"},{"id":"385591","messageId":"796bc03408273097847185f9130d4992e1ee8121.1573044509.git.gitgitgadget@gmail.com","threadId":"52201","inReplyTo":"pull.456.git.1573044509.gitgitgadget@gmail.com","subject":"[PATCH 1/1] api-index: remove api doc index files","fromName":"Heba Waly via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2019-11-06T12:48:29Z","receivedAt":"2019-11-06T12:48:36Z","isPatch":true,"sender":{"key":"heba.waly@gmail.com","avatar":"https://avatars.githubusercontent.com/u/1539076?v=4"},"body":"From: Heba Waly \n\nRemove both api-index.txt and api-index-skel.txt as the API documentation\nis being moved to the header files, so the index is not needed anymore\nbecause the doc files (Documentation/technical/api-*.txt) will be gone.\n\nMake changes to Documentation/Makefile accordingly.\n\nSigned-off-by: Heba Waly \n---\n Documentation/Makefile | 11 +++------\n Documentation/git.txt | 3 ---\n Documentation/technical/.gitignore | 1 -\n Documentation/technical/api-index-skel.txt | 13 ----------\n Documentation/technical/api-index.sh | 28 ----------------------\n 5 files changed, 3 insertions(+), 53 deletions(-)\n delete mode 100644 Documentation/technical/.gitignore\n delete mode 100644 Documentation/technical/api-index-skel.txt\n delete mode 100755 Documentation/technical/api-index.sh\n\ndiff --git a/Documentation/Makefile b/Documentation/Makefile\nindex 06d85ad958..0788dd12e8 100644\n--- a/Documentation/Makefile\n+++ b/Documentation/Makefile\n@@ -73,7 +73,7 @@ SP_ARTICLES += howto/rebuild-from-update-hook\n SP_ARTICLES += howto/rebase-from-internal-branch\n SP_ARTICLES += howto/keep-canonical-history-correct\n SP_ARTICLES += howto/maintain-git\n-API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technical/api-index.txt, $(wildcard technical/api-*.txt)))\n+API_DOCS = $(patsubst %.txt,%,$(wildcard technical/api-*.txt))\n SP_ARTICLES += $(API_DOCS)\n \n TECH_DOCS += MyFirstContribution\n@@ -96,7 +96,6 @@ TECH_DOCS += technical/shallow\n TECH_DOCS += technical/signature-format\n TECH_DOCS += technical/trivial-merge\n SP_ARTICLES += $(TECH_DOCS)\n-SP_ARTICLES += technical/api-index\n \n ARTICLES_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES))\n HTML_FILTER ?= $(ARTICLES_HTML) $(OBSOLETE_HTML)\n@@ -352,7 +351,7 @@ clean:\n \t$(RM) *.texi *.texi+ *.texi++ git.info gitman.info\n \t$(RM) *.pdf\n \t$(RM) howto-index.txt howto/*.html doc.dep\n-\t$(RM) technical/*.html technical/api-index.txt\n+\t$(RM) technical/*.html\n \t$(RM) SubmittingPatches.txt\n \t$(RM) $(cmds_txt) $(mergetools_txt) *.made\n \t$(RM) manpage-base-url.xsl\n@@ -385,12 +384,8 @@ user-manual.xml: user-manual.txt user-manual.conf asciidoctor-extensions.rb GIT-\n \t$(TXT_TO_XML) -d book -o $@+ $< && \\\n \tmv $@+ $@\n \n-technical/api-index.txt: technical/api-index-skel.txt \\\n-\ttechnical/api-index.sh $(patsubst %,%.txt,$(API_DOCS))\n-\t$(QUIET_GEN)cd technical && '$(SHELL_PATH_SQ)' ./api-index.sh\n-\n technical/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../\n-$(patsubst %,%.html,$(API_DOCS) technical/api-index $(TECH_DOCS)): %.html : %.txt \\\n+$(patsubst %,%.html,$(API_DOCS) $(TECH_DOCS)): %.html : %.txt \\\n \tasciidoc.conf GIT-ASCIIDOCFLAGS\n \t$(QUIET_ASCIIDOC)$(TXT_TO_HTML) $*.txt\n \ndiff --git a/Documentation/git.txt b/Documentation/git.txt\nindex 9b82564d1a..0fdd93ac95 100644\n--- a/Documentation/git.txt\n+++ b/Documentation/git.txt\n@@ -904,9 +904,6 @@ See linkgit:gitworkflows[7] for an overview of recommended workflows.\n See also the link:howto-index.html[howto] documents for some useful\n examples.\n \n-The internals are documented in the\n-link:technical/api-index.html[Git API documentation].\n-\n Users migrating from CVS may also want to\n read linkgit:gitcvs-migration[7].\n \ndiff --git a/Documentation/technical/.gitignore b/Documentation/technical/.gitignore\ndeleted file mode 100644\nindex 8aa891daee..0000000000\n--- a/Documentation/technical/.gitignore\n+++ /dev/null\n@@ -1 +0,0 @@\n-api-index.txt\ndiff --git a/Documentation/technical/api-index-skel.txt b/Documentation/technical/api-index-skel.txt\ndeleted file mode 100644\nindex eda8c195c1..0000000000\n--- a/Documentation/technical/api-index-skel.txt\n+++ /dev/null\n@@ -1,13 +0,0 @@\n-Git API Documents\n-=================\n-\n-Git has grown a set of internal API over time. This collection\n-documents them.\n-\n-////////////////////////////////////////////////////////////////\n-// table of contents begin\n-////////////////////////////////////////////////////////////////\n-\n-////////////////////////////////////////////////////////////////\n-// table of contents end\n-////////////////////////////////////////////////////////////////\ndiff --git a/Documentation/technical/api-index.sh b/Documentation/technical/api-index.sh\ndeleted file mode 100755\nindex 9c3f4131b8..0000000000\n--- a/Documentation/technical/api-index.sh\n+++ /dev/null\n@@ -1,28 +0,0 @@\n-#!/bin/sh\n-\n-(\n-\tc=////////////////////////////////////////////////////////////////\n-\tskel=api-index-skel.txt\n-\tsed -e '/^\\/\\/ table of contents begin/q' \"$skel\"\n-\techo \"$c\"\n-\n-\tls api-*.txt |\n-\twhile read filename\n-\tdo\n-\t\tcase \"$filename\" in\n-\t\tapi-index-skel.txt | api-index.txt) continue ;;\n-\t\tesac\n-\t\ttitle=$(sed -e 1q \"$filename\")\n-\t\thtml=${filename%.txt}.html\n-\t\techo \"* link:$html[$title]\"\n-\tdone\n-\techo \"$c\"\n-\tsed -n -e '/^\\/\\/ table of contents end/,$p' \"$skel\"\n-) >api-index.txt+\n-\n-if test -f api-index.txt && cmp api-index.txt api-index.txt+ >/dev/null\n-then\n-\trm -f api-index.txt+\n-else\n-\tmv api-index.txt+ api-index.txt\n-fi\n-- \ngitgitgadget\n"},{"id":"385669","messageId":"xmqq7e4cqk9y.fsf@gitster-ct.c.googlers.com","threadId":"52201","inReplyTo":"pull.456.git.1573044509.gitgitgadget@gmail.com","subject":"Re: [PATCH 0/1] [Outreachy] doc: remove api-index","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2019-11-07T06:21:13Z","receivedAt":"2019-11-07T06:21:20Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"\"Heba Waly via GitGitGadget\" writes:\n\n> Remove both api-index.txt and api-index-skel.txt as the API documentation is\n> being moved to the header files, so the index is not needed anymore because\n> the doc files (Documentation/technical/api-*.txt) will be gone.\n>\n> Make changes to Documentation/Makefile accordingly.\n\nWhy is this not part of the other series? Without any of them this\nstep does not make sense, no?\n"},{"id":"385836","messageId":"CACg5j25S8eJN5Sc9cm_DEu50bmaR5fQBT7dAid2z-Be2y_rpmg@mail.gmail.com","threadId":"52201","inReplyTo":"xmqq7e4cqk9y.fsf@gitster-ct.c.googlers.com","subject":"Re: [PATCH 0/1] [Outreachy] doc: remove api-index","fromName":"Heba Waly","fromEmail":"heba.waly@gmail.com","sentAt":"2019-11-10T01:06:39Z","receivedAt":"2019-11-10T01:06:55Z","isPatch":true,"sender":{"key":"heba.waly@gmail.com","avatar":"https://avatars.githubusercontent.com/u/1539076?v=4"},"body":"On Thu, Nov 7, 2019 at 7:21 PM Junio C Hamano wrote:\n>\n> \"Heba Waly via GitGitGadget\" writes:\n>\n> > Remove both api-index.txt and api-index-skel.txt as the API documentation is\n> > being moved to the header files, so the index is not needed anymore because\n> > the doc files (Documentation/technical/api-*.txt) will be gone.\n> >\n> > Make changes to Documentation/Makefile accordingly.\n>\n> Why is this not part of the other series? Without any of them this\n> step does not make sense, no?\n\nMoving it to the other series makes more sense, although I won't\nconsider it dependent on removing the rest of the files, as we're\nchanging the location of the documentation anyway, and readers will\nneed to refer to the code for more info. But I agree with you and will\nmove it there.\n\nThanks,\nHeba\n"}]}