git: fbc1409c73 - main - Use @generated in generated files

[Ed Maste]

The branch main has been updated by emaste (src committer):

URL: https://cgit.FreeBSD.org/doc/commit/?id=fbc1409c73012ea3d33c1bad851530ed29eb80da

commit fbc1409c73012ea3d33c1bad851530ed29eb80da
Author:     Ed Maste <emaste at FreeBSD.org>
AuthorDate: 2021-02-01 17:55:05 +0000
Commit:     Ed Maste <emaste at FreeBSD.org>
CommitDate: 2021-02-04 14:39:06 +0000

    Use @generated in generated files
    
    @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
---
 documentation/tools/books-toc-creator.py          | 2 +-
 documentation/tools/books-toc-examples-creator.py | 2 +-
 documentation/tools/books-toc-figures-creator.py  | 2 +-
 documentation/tools/books-toc-parts-creator.py    | 2 +-
 documentation/tools/books-toc-tables-creator.py   | 2 +-
 website/tools/releases-toml.py                    | 2 +-
 6 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/documentation/tools/books-toc-creator.py b/documentation/tools/books-toc-creator.py
index 5d05448801..f5b4721a69 100644
--- a/documentation/tools/books-toc-creator.py
+++ b/documentation/tools/books-toc-creator.py
@@ -143,7 +143,7 @@ def main(argv):
     with open('./content/{0}/books/handbook/chapters-order.adoc'.format(language), 'r', encoding = 'utf-8') as 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 += "// For more information, please read the FreeBSD Documentation Project Primer\n\n"
     toc += "[.toc]\n"
diff --git a/documentation/tools/books-toc-examples-creator.py b/documentation/tools/books-toc-examples-creator.py
index 1040b3cdfb..f72ffa945e 100644
--- a/documentation/tools/books-toc-examples-creator.py
+++ b/documentation/tools/books-toc-examples-creator.py
@@ -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:
           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 += "// For more information, please read the FreeBSD Documentation Project Primer\n\n"
         toc += "[.toc]\n"
diff --git a/documentation/tools/books-toc-figures-creator.py b/documentation/tools/books-toc-figures-creator.py
index 05139ffa80..46bea6226b 100644
--- a/documentation/tools/books-toc-figures-creator.py
+++ b/documentation/tools/books-toc-figures-creator.py
@@ -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:
           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 += "// For more information, please read the FreeBSD Documentation Project Primer\n\n"
         toc += "[.toc]\n"
diff --git a/documentation/tools/books-toc-parts-creator.py b/documentation/tools/books-toc-parts-creator.py
index d36e8a3dde..86ed31fbd1 100644
--- a/documentation/tools/books-toc-parts-creator.py
+++ b/documentation/tools/books-toc-parts-creator.py
@@ -20,7 +20,7 @@ def cleanTocFile(language, tocCounter):
         tocFile.truncate(0)
 
 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 += "// For more information, please read the FreeBSD Documentation Project Primer\n\n"
   toc += "[.toc]\n"
diff --git a/documentation/tools/books-toc-tables-creator.py b/documentation/tools/books-toc-tables-creator.py
index 7ebd7acdec..592330b7a4 100644
--- a/documentation/tools/books-toc-tables-creator.py
+++ b/documentation/tools/books-toc-tables-creator.py
@@ -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:
           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 += "// For more information, please read the FreeBSD Documentation Project Primer\n\n"
         toc += "[.toc]\n"
diff --git a/website/tools/releases-toml.py b/website/tools/releases-toml.py
index 2e0b72b688..2dc96d310f 100644
--- a/website/tools/releases-toml.py
+++ b/website/tools/releases-toml.py
@@ -49,7 +49,7 @@ def main(argv):
     elif opt in ("-p", "--path"):
       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 += "# For more information, please read the FreeBSD Documentation Project Primer\n"
   releasesTOML += '\n'