os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Use @generated in generated files

Browse source 
@generated is used by various tools to identify generated files.
For example, Phabricator will not display diffs in generated files
by default.

Reviewed by:	gjb
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D28446
This commit is contained in:
Ed Maste 2021-02-01 12:55:05 -05:00
parent e11aaf5a76
commit fbc1409c73
6 changed files with 6 additions and 6 deletions

2
documentation/tools/books-toc-creator.py
View file

@ -143,7 +143,7 @@ def main(argv):
with open('./content/{0}/books/handbook/chapters-order.adoc'.format(language), 'r', encoding = 'utf-8') as chaptersFile: with open('./content/{0}/books/handbook/chapters-order.adoc'.format(language), 'r', encoding = 'utf-8') as chaptersFile:
chapters = [line.strip() for line in chaptersFile] chapters = [line.strip() for line in chaptersFile]
toc = "// Code generated by the FreeBSD Documentation toolchain. DO NOT EDIT.\n" toc = "// Code @" + "generated by the FreeBSD Documentation toolchain. DO NOT EDIT.\n"
toc += "// Please don't change this file manually but run `make` to update it.\n" toc += "// Please don't change this file manually but run `make` to update it.\n"
toc += "// For more information, please read the FreeBSD Documentation Project Primer\n\n" toc += "// For more information, please read the FreeBSD Documentation Project Primer\n\n"
toc += "[.toc]\n" toc += "[.toc]\n"

2
documentation/tools/books-toc-examples-creator.py
View file

@ -75,7 +75,7 @@ def main(argv):
with open('./content/{0}/books/{1}/chapters-order.adoc'.format(language, book), 'r', encoding = 'utf-8') as chaptersFile: with open('./content/{0}/books/{1}/chapters-order.adoc'.format(language, book), 'r', encoding = 'utf-8') as chaptersFile:
chapters = [line.strip() for line in chaptersFile] chapters = [line.strip() for line in chaptersFile]
toc = "// Code generated by the FreeBSD Documentation toolchain. DO NOT EDIT.\n" toc = "// Code @" + "generated by the FreeBSD Documentation toolchain. DO NOT EDIT.\n"
toc += "// Please don't change this file manually but run `make` to update it.\n" toc += "// Please don't change this file manually but run `make` to update it.\n"
toc += "// For more information, please read the FreeBSD Documentation Project Primer\n\n" toc += "// For more information, please read the FreeBSD Documentation Project Primer\n\n"
toc += "[.toc]\n" toc += "[.toc]\n"

2
documentation/tools/books-toc-figures-creator.py
View file

@ -75,7 +75,7 @@ def main(argv):
with open('./content/{0}/books/{1}/chapters-order.adoc'.format(language, book), 'r', encoding = 'utf-8') as chaptersFile: with open('./content/{0}/books/{1}/chapters-order.adoc'.format(language, book), 'r', encoding = 'utf-8') as chaptersFile:
chapters = [line.strip() for line in chaptersFile] chapters = [line.strip() for line in chaptersFile]
toc = "// Code generated by the FreeBSD Documentation toolchain. DO NOT EDIT.\n" toc = "// Code @" + "generated by the FreeBSD Documentation toolchain. DO NOT EDIT.\n"
toc += "// Please don't change this file manually but run `make` to update it.\n" toc += "// Please don't change this file manually but run `make` to update it.\n"
toc += "// For more information, please read the FreeBSD Documentation Project Primer\n\n" toc += "// For more information, please read the FreeBSD Documentation Project Primer\n\n"
toc += "[.toc]\n" toc += "[.toc]\n"

2
documentation/tools/books-toc-parts-creator.py
View file

@ -20,7 +20,7 @@ def cleanTocFile(language, tocCounter):
tocFile.truncate(0) tocFile.truncate(0)
def appendCommendAndTitle(language, tocCounter, tocContent): def appendCommendAndTitle(language, tocCounter, tocContent):
toc = "// Code generated by the FreeBSD Documentation toolchain. DO NOT EDIT.\n" toc = "// Code @" + "generated by the FreeBSD Documentation toolchain. DO NOT EDIT.\n"
toc += "// Please don't change this file manually but run `make` to update it.\n" toc += "// Please don't change this file manually but run `make` to update it.\n"
toc += "// For more information, please read the FreeBSD Documentation Project Primer\n\n" toc += "// For more information, please read the FreeBSD Documentation Project Primer\n\n"
toc += "[.toc]\n" toc += "[.toc]\n"

2
documentation/tools/books-toc-tables-creator.py
View file

@ -75,7 +75,7 @@ def main(argv):
with open('./content/{0}/books/{1}/chapters-order.adoc'.format(language, book), 'r', encoding = 'utf-8') as chaptersFile: with open('./content/{0}/books/{1}/chapters-order.adoc'.format(language, book), 'r', encoding = 'utf-8') as chaptersFile:
chapters = [line.strip() for line in chaptersFile] chapters = [line.strip() for line in chaptersFile]
toc = "// Code generated by the FreeBSD Documentation toolchain. DO NOT EDIT.\n" toc = "// Code @" + "generated by the FreeBSD Documentation toolchain. DO NOT EDIT.\n"
toc += "// Please don't change this file manually but run `make` to update it.\n" toc += "// Please don't change this file manually but run `make` to update it.\n"
toc += "// For more information, please read the FreeBSD Documentation Project Primer\n\n" toc += "// For more information, please read the FreeBSD Documentation Project Primer\n\n"
toc += "[.toc]\n" toc += "[.toc]\n"

2
website/tools/releases-toml.py
View file

@ -49,7 +49,7 @@ def main(argv):
elif opt in ("-p", "--path"): elif opt in ("-p", "--path"):
path = arg path = arg
releasesTOML = "# Code generated by the FreeBSD Documentation toolchain. DO NOT EDIT.\n" releasesTOML = "# Code @" + "generated by the FreeBSD Documentation toolchain. DO NOT EDIT.\n"
releasesTOML += "# Please don't change this file manually but run `make` to update it.\n" releasesTOML += "# Please don't change this file manually but run `make` to update it.\n"
releasesTOML += "# For more information, please read the FreeBSD Documentation Project Primer\n" releasesTOML += "# For more information, please read the FreeBSD Documentation Project Primer\n"
releasesTOML += '\n' releasesTOML += '\n'