view doc/Makefile @ 8356:63390dcfcfe9

bug: fix template use of structure with untrusted data Looks like an xSS bug with an early version of the template that was fixed in the code but never in the deployed tracker. It has been a while since this particular construct has been in the classic template which is the base for the tracker. This has been fixed on the deployed tracker as well. reported by 4bug of ChaMd5 Security Team H1 Group
author John Rouillard <rouilj@ieee.org>
date Tue, 08 Jul 2025 10:23:09 -0400
parents c3bf229d3d4b
children
line wrap: on
line source

##@ Default target
all:  man_html tracker_config.txt admin_help.html ## make all docs under share
	cd ..; ./setup.py build_doc

##@ build doc parts
tracker_config.txt: ../roundup/configuration.py format_config.awk ## generate a current config file

	python3 ../roundup/scripts/roundup_admin.py \
               genconfig _temp_config.txt

	awk -f format_config.awk _temp_config.txt | \
	    cat -s > tracker_config.txt
	rm -f _temp_config.txt

## generate html versions of man pages for inclusion in documentation
# find all man pages and generate output file paths.
MAN_ROFF=$(wildcard ../share/man/man1/*.1)
MAN_HTML=$(patsubst ../share/man/man1/%.1,html_extra/man_pages/%.1.html,$(MAN_ROFF))

man_html: $(MAN_HTML) ## generate html versions of man pages for docs

html_extra/man_pages/%.1.html: ../share/man/man1/%.1
	man --html=cat $< > $@
	# set max width for paragraphs
	sed -i '/<style/,/<\/style/s/\(p\s* { \)margin/\1max-width: 65ch; margin/' $@
	# add link rel=cannonical $@(F) takes
	# target $@ (html_extra/man_pages/x.1.html)
	# and returns file part (x.1.html)
	sed -i '/<head>/,/<\/head>/s#^<style#<link rel="canonical" href="https://www.roundup-tracker.org/docs/man_pages/$(@F)">\n<style#' $@
	#man2html $< > $@

admin_help.html: ../roundup/admin.py ## generate html version of roundup-admin help (WIP)
	python3 ../roundup/scripts/roundup_admin.py htmlhelp > admin_help.html

##@ Utilties

clean: ## clean all generated docs
	rm -f _temp_config.txt tracker_config.txt \
	      html_extra/man_pages/*.1.html \
	      admin_help.py

# from https://www.thapaliya.com/en/writings/well-documented-makefiles/ via
# https://til.jakelazaroff.com/make/list-all-commands-in-a-makefile/
help:  ## this output
	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[.a-zA-Z_-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)

Roundup Issue Tracker: http://roundup-tracker.org/