Sun Feb 23 18:09:36 2020 UTC ()
doc/guide: document why autogenerated IDs are forbidden


(rillig)
diff -r1.60 -r1.61 pkgsrc/doc/guide/Makefile
cvs diff -r1.60 -r1.61 pkgsrc/doc/guide/Makefile (expand / switch to unified diff)

--- pkgsrc/doc/guide/Makefile 2020/02/23 17:43:20 1.60
+++ pkgsrc/doc/guide/Makefile 2020/02/23 18:09:36 1.61
@@ -1,14 +1,14 @@ @@ -1,14 +1,14 @@
1# $NetBSD: Makefile,v 1.60 2020/02/23 17:43:20 rillig Exp $ 1# $NetBSD: Makefile,v 1.61 2020/02/23 18:09:36 rillig Exp $
2 2
3DISTNAME= pkgsrc-guide-${PKGVERSION} 3DISTNAME= pkgsrc-guide-${PKGVERSION}
4CATEGORIES= # empty 4CATEGORIES= # empty
5MASTER_SITES= ${MASTER_SITE_LOCAL} 5MASTER_SITES= ${MASTER_SITE_LOCAL}
6DISTFILES= htdocs-share-20200106.tar.gz 6DISTFILES= htdocs-share-20200106.tar.gz
7 7
8MAINTAINER= pkgsrc-users@NetBSD.org 8MAINTAINER= pkgsrc-users@NetBSD.org
9HOMEPAGE= http://www.NetBSD.org/docs/pkgsrc/ 9HOMEPAGE= http://www.NetBSD.org/docs/pkgsrc/
10COMMENT= The pkgsrc guide 10COMMENT= The pkgsrc guide
11 11
12# To regenerate pkgsrc/doc/pkgsrc.{html,txt} and 12# To regenerate pkgsrc/doc/pkgsrc.{html,txt} and
13# htdocs/docs/pkgsrc, just run "make regen". 13# htdocs/docs/pkgsrc, just run "make regen".
14 14
@@ -73,26 +73,28 @@ generate-help-topics: .PHONY @@ -73,26 +73,28 @@ generate-help-topics: .PHONY
73 ${RUN} cd ${WRKSRC} && env PKGSRCDIR=${PKGSRCDIR} python fill-placeholders.py *.xml 73 ${RUN} cd ${WRKSRC} && env PKGSRCDIR=${PKGSRCDIR} python fill-placeholders.py *.xml
74 74
75do-build: 75do-build:
76.for _output_ in ${OUTPUTS} 76.for _output_ in ${OUTPUTS}
77 @${ECHO} "-----> Building ${_output_} output" 77 @${ECHO} "-----> Building ${_output_} output"
78 @cd ${WRKSRC} && ${SETENV} ${MAKE_ENV} ${MAKE_PROGRAM} ${MAKE_FLAGS} ${_output_} 78 @cd ${WRKSRC} && ${SETENV} ${MAKE_ENV} ${MAKE_PROGRAM} ${MAKE_FLAGS} ${_output_}
79.endfor 79.endfor
80 80
81post-build: 81post-build:
82 @${RM} -f ${WRKSRC}/pkgsrc.tmp.html 82 @${RM} -f ${WRKSRC}/pkgsrc.tmp.html
83 ${RUN} cd ${WRKSRC}; \ 83 ${RUN} cd ${WRKSRC}; \
84 ${GREP} 'idm[0-9][0-9][0-9][0-9][0-9]' ./*.html || exit 0; \ 84 ${GREP} 'idm[0-9][0-9][0-9][0-9][0-9]' ./*.html || exit 0; \
85 ${FAIL_MSG} "[post-build] HTML files contain generated IDs." 85 ${FAIL_MSG} "[post-build] HTML files contain generated IDs."
 86 # These IDs generate unnecessary changes to the generated files,
 87 # when they are committed to pkgsrc/doc/ and htdocs.
86 88
87do-install: 89do-install:
88.if !empty(OUTPUTS:Mhtml) || !empty(OUTPUTS:Mhtml-split) 90.if !empty(OUTPUTS:Mhtml) || !empty(OUTPUTS:Mhtml-split)
89 ${INSTALL_DATA} ${WRKSRC}/*.html ${DESTDIR}${DOCDIR} 91 ${INSTALL_DATA} ${WRKSRC}/*.html ${DESTDIR}${DOCDIR}
90 ${INSTALL_DATA} ${WRKDIR}/htdocs/global.css ${DESTDIR}${DOCDIR} 92 ${INSTALL_DATA} ${WRKDIR}/htdocs/global.css ${DESTDIR}${DOCDIR}
91.endif 93.endif
92.if !empty(OUTPUTS:Mascii) 94.if !empty(OUTPUTS:Mascii)
93 ${INSTALL_DATA} ${WRKSRC}/pkgsrc.txt ${DESTDIR}${DOCDIR} 95 ${INSTALL_DATA} ${WRKSRC}/pkgsrc.txt ${DESTDIR}${DOCDIR}
94.endif 96.endif
95.if !empty(OUTPUTS:Mpdf) 97.if !empty(OUTPUTS:Mpdf)
96 ${INSTALL_DATA} ${WRKSRC}/pkgsrc.ps ${DESTDIR}${DOCDIR} 98 ${INSTALL_DATA} ${WRKSRC}/pkgsrc.ps ${DESTDIR}${DOCDIR}
97 ${INSTALL_DATA} ${WRKSRC}/pkgsrc.pdf ${DESTDIR}${DOCDIR} 99 ${INSTALL_DATA} ${WRKSRC}/pkgsrc.pdf ${DESTDIR}${DOCDIR}
98.endif 100.endif