Skip to content

Commit 387a35a

Browse files
HebaWalygitster
authored andcommitted
api-index: remove api doc index files
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 190d8b0 commit 387a35a

File tree

5 files changed

+3
-53
lines changed

5 files changed

+3
-53
lines changed

Documentation/Makefile

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ SP_ARTICLES += howto/rebuild-from-update-hook
7373
SP_ARTICLES += howto/rebase-from-internal-branch
7474
SP_ARTICLES += howto/keep-canonical-history-correct
7575
SP_ARTICLES += howto/maintain-git
76-
API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technical/api-index.txt, $(wildcard technical/api-*.txt)))
76+
API_DOCS = $(patsubst %.txt,%,$(wildcard technical/api-*.txt))
7777
SP_ARTICLES += $(API_DOCS)
7878

7979
TECH_DOCS += MyFirstContribution
@@ -97,7 +97,6 @@ TECH_DOCS += technical/shallow
9797
TECH_DOCS += technical/signature-format
9898
TECH_DOCS += technical/trivial-merge
9999
SP_ARTICLES += $(TECH_DOCS)
100-
SP_ARTICLES += technical/api-index
101100

102101
ARTICLES_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES))
103102
HTML_FILTER ?= $(ARTICLES_HTML) $(OBSOLETE_HTML)
@@ -353,7 +352,7 @@ clean:
353352
$(RM) *.texi *.texi+ *.texi++ git.info gitman.info
354353
$(RM) *.pdf
355354
$(RM) howto-index.txt howto/*.html doc.dep
356-
$(RM) technical/*.html technical/api-index.txt
355+
$(RM) technical/*.html
357356
$(RM) SubmittingPatches.txt
358357
$(RM) $(cmds_txt) $(mergetools_txt) *.made
359358
$(RM) manpage-base-url.xsl
@@ -386,12 +385,8 @@ user-manual.xml: user-manual.txt user-manual.conf asciidoctor-extensions.rb GIT-
386385
$(TXT_TO_XML) -d book -o $@+ $< && \
387386
mv $@+ $@
388387

389-
technical/api-index.txt: technical/api-index-skel.txt \
390-
technical/api-index.sh $(patsubst %,%.txt,$(API_DOCS))
391-
$(QUIET_GEN)cd technical && '$(SHELL_PATH_SQ)' ./api-index.sh
392-
393388
technical/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../
394-
$(patsubst %,%.html,$(API_DOCS) technical/api-index $(TECH_DOCS)): %.html : %.txt \
389+
$(patsubst %,%.html,$(API_DOCS) $(TECH_DOCS)): %.html : %.txt \
395390
asciidoc.conf GIT-ASCIIDOCFLAGS
396391
$(QUIET_ASCIIDOC)$(TXT_TO_HTML) $*.txt
397392

Documentation/git.txt

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -904,9 +904,6 @@ See linkgit:gitworkflows[7] for an overview of recommended workflows.
904904
See also the link:howto-index.html[howto] documents for some useful
905905
examples.
906906

907-
The internals are documented in the
908-
link:technical/api-index.html[Git API documentation].
909-
910907
Users migrating from CVS may also want to
911908
read linkgit:gitcvs-migration[7].
912909

Documentation/technical/.gitignore

Lines changed: 0 additions & 1 deletion
This file was deleted.

Documentation/technical/api-index-skel.txt

Lines changed: 0 additions & 13 deletions
This file was deleted.

Documentation/technical/api-index.sh

Lines changed: 0 additions & 28 deletions
This file was deleted.

0 commit comments

Comments
 (0)