upstream/mercurial-mirror Files · doc/Makefile

py3: fix broken man page generation, it was generating `(default: NUL*)`...

py3: fix broken man page generation, it was generating `(default: NUL*)` `bytes(default)` was producing things like `(default: \x00)` when handed non-bytes values such as `1`, `10`, or `True`. The man page generation would apparently ignore these bytes and produce man pages that had the string `(default: )`. Test Plan: - Ran `cd doc; python3 gendoc.py "hg.1.gendoc"` and grepped for bad output - Ran `make deb`, extracted the deb, manually inspected `hg.1` file. Differential Revision: https://phab.mercurial-scm.org/D8639

Matt Harbison - - Load All Authors

File last commit:

r45215:eb9026a8 default


                r45509:1a4b9b60

stable

Download file

             Makefile
        
                    48 lines
            
             | 1.3 KiB
            
                | text/x-makefile
            
             |
                MakefileLexer
            
             / doc / Makefile
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      SOURCES=$(notdir $(wildcard ../mercurial/helptext/*.[0-9].txt))

      MAN=$(SOURCES:%.txt=%)

      HTML=$(SOURCES:%.txt=%.html)

      GENDOC=gendoc.py ../mercurial/commands.py ../mercurial/help.py \

      	../mercurial/helptext/*.txt ../hgext/*.py ../hgext/*/__init__.py

      PREFIX=/usr/local

      MANDIR=$(PREFIX)/share/man

      INSTALL=install -m 644

      PYTHON?=python

      RSTARGS=

      export HGENCODING=UTF-8

      all: man html

      man: $(MAN)

      html: $(HTML)

      # This logic is duplicated in setup.py:hgbuilddoc()

      common.txt $(SOURCES) $(SOURCES:%.txt=%.gendoc.txt): $(GENDOC)

      	${PYTHON} gendoc.py "$(basename $@)" > $@.tmp

      	mv $@.tmp $@

      %: %.txt %.gendoc.txt common.txt

      	$(PYTHON) runrst hgmanpage $(RSTARGS) --halt warning \

      	  --strip-elements-with-class htmlonly $*.txt $*

      %.html: %.txt %.gendoc.txt common.txt

      	$(PYTHON) runrst html $(RSTARGS) --halt warning \

      	  --link-stylesheet --stylesheet-path style.css $*.txt $*.html

      MANIFEST: man html

      # tracked files are already in the main MANIFEST

      	$(RM) $@

      	for i in $(MAN) $(HTML); do \

      	  echo "doc/$$i" >> $@ ; \

      	done

      install: man

      	for i in $(MAN) ; do \

      	  subdir=`echo $$i | sed -n 's/^.*\.\([0-9]\)$$/man\1/p'` ; \

      	  mkdir -p "$(DESTDIR)$(MANDIR)"/$$subdir ; \

      	  $(INSTALL) $$i "$(DESTDIR)$(MANDIR)"/$$subdir ; \

      	done

      clean:

      	$(RM) $(MAN) $(HTML) common.txt $(SOURCES) $(SOURCES:%.txt=%.gendoc.txt) MANIFEST

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

				SOURCES=$(notdir $(wildcard ../mercurial/helptext/*.[0-9].txt))
				MAN=$(SOURCES:%.txt=%)
				HTML=$(SOURCES:%.txt=%.html)
				GENDOC=gendoc.py ../mercurial/commands.py ../mercurial/help.py \
				../mercurial/helptext/.txt ../hgext/.py ../hgext/*/__init__.py
				PREFIX=/usr/local
				MANDIR=$(PREFIX)/share/man
				INSTALL=install -m 644
				PYTHON?=python
				RSTARGS=

				export HGENCODING=UTF-8

				all: man html

				man: $(MAN)

				html: $(HTML)

				# This logic is duplicated in setup.py:hgbuilddoc()
				common.txt $(SOURCES) $(SOURCES:%.txt=%.gendoc.txt): $(GENDOC)
				${PYTHON} gendoc.py "$(basename $@)" > $@.tmp
				mv $@.tmp $@

				%: %.txt %.gendoc.txt common.txt
				$(PYTHON) runrst hgmanpage $(RSTARGS) --halt warning \
				--strip-elements-with-class htmlonly $.txt $

				%.html: %.txt %.gendoc.txt common.txt
				$(PYTHON) runrst html $(RSTARGS) --halt warning \
				--link-stylesheet --stylesheet-path style.css $.txt $.html

				MANIFEST: man html
				# tracked files are already in the main MANIFEST
				$(RM) $@
				for i in $(MAN) $(HTML); do \
				echo "doc/$$i" >> $@ ; \
				done

				install: man
				for i in $(MAN) ; do \
				subdir=`echo $$i \| sed -n 's/^.*\.\([0-9]\)$$/man\1/p'` ; \
				mkdir -p "$(DESTDIR)$(MANDIR)"/$$subdir ; \
				$(INSTALL) $$i "$(DESTDIR)$(MANDIR)"/$$subdir ; \
				done

				clean:
				$(RM) $(MAN) $(HTML) common.txt $(SOURCES) $(SOURCES:%.txt=%.gendoc.txt) MANIFEST