161d2df58b
The docs/man/index.txt file is intended to provide URL mappings for the HTML hyperlinks ronn(1) can generate for references it finds in our manual page Markdown source files; e.g., the text strings "git-config(1)" and "gitignore(5)" can be hyperlinked to appropriate URLs wherever they appear. However, because we run ronn in the top-level directory of the project, the docs/man/index.txt file is never seen or used. Moreover, it contains only a single URL mapping, and that goes to an older manual page hosting site (and uses HTTP not HTTPS). If we generate the index.txt file dynamically before running ronn then we can extract all the currently listed external manual page references (i.e., those not referring to other Git LFS manual pages) from the "SEE ALSO" sections of our *.ronn source files, and map those to corresponding URLs under either https://git-scm.com/docs/ for Git manual pages or https://man7.org/linux/man-pages/ for other references. And by placing this dynamically generated index.txt file in the top-level directory, we can ensure that ronn will find and utilize it. Finally, we add our new index.txt to our .gitignore because it's now generated at build time, and we remove the old docs/man/index.txt file.
45 lines
439 B
Plaintext
45 lines
439 B
Plaintext
bin/
|
|
benchmark/
|
|
out/
|
|
resource.syso
|
|
|
|
# only allow man/*.\d.ronn files
|
|
man/*
|
|
index.txt
|
|
|
|
*.test
|
|
tmp
|
|
t/remote
|
|
t/scutiger
|
|
t/test_count
|
|
t/test_count.lock
|
|
|
|
debian/git-lfs/
|
|
debian/*.log
|
|
debian/files
|
|
debian/*.substvars
|
|
debian/debhelper-build-stamp
|
|
debian/.debhelper
|
|
/.pc
|
|
obj-*
|
|
|
|
rpm/BUILD*
|
|
rpm/*RPMS
|
|
rpm/*.log
|
|
rpm/SOURCES
|
|
|
|
repos
|
|
docker/*.key
|
|
|
|
src
|
|
commands/mancontent_gen.go
|
|
|
|
po/build
|
|
po/i-reverse.po
|
|
*.mo
|
|
*.pot
|
|
tr/tr_gen.go
|
|
|
|
lfstest-*
|
|
!lfstest-*.go
|