summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2021-01-30 18:19:57 -0500
committerNed Batchelder <ned@nedbatchelder.com>2021-01-30 18:20:40 -0500
commit4fc64a97ce779c2d6bb972f0003b9b9f00e62c3a (patch)
treec23b743c69380899c65690ebe8f89ce3d08cce69
parent814023c72082c75684259b7980f7b3465785b110 (diff)
downloadpython-coveragepy-git-4fc64a97ce779c2d6bb972f0003b9b9f00e62c3a.tar.gz
build: clearly label auto-generated files
-rw-r--r--Makefile2
-rw-r--r--doc/help/annotate.rst2
-rw-r--r--doc/help/combine.rst2
-rw-r--r--doc/help/debug.rst2
-rw-r--r--doc/help/erase.rst2
-rw-r--r--doc/help/html.rst2
-rw-r--r--doc/help/json.rst2
-rw-r--r--doc/help/report.rst2
-rw-r--r--doc/help/run.rst2
-rw-r--r--doc/help/xml.rst2
10 files changed, 20 insertions, 0 deletions
diff --git a/Makefile b/Makefile
index 4bc811e2..d7bc15b7 100644
--- a/Makefile
+++ b/Makefile
@@ -121,6 +121,8 @@ $(DOCBIN):
cmd_help: $(DOCBIN)
@for cmd in annotate combine debug erase html json report run xml; do \
echo > doc/help/$$cmd.rst; \
+ echo ".. This file is auto-generated by \"make dochtml\", don't edit it manually." >> doc/help/$$cmd.rst; \
+ echo >> doc/help/$$cmd.rst; \
echo ".. code::" >> doc/help/$$cmd.rst; \
echo >> doc/help/$$cmd.rst; \
echo " $$ coverage $$cmd --help" >> doc/help/$$cmd.rst; \
diff --git a/doc/help/annotate.rst b/doc/help/annotate.rst
index 8f0883a0..c8d59719 100644
--- a/doc/help/annotate.rst
+++ b/doc/help/annotate.rst
@@ -1,4 +1,6 @@
+.. This file is auto-generated by "make dochtml", don't edit it manually.
+
.. code::
$ coverage annotate --help
diff --git a/doc/help/combine.rst b/doc/help/combine.rst
index 7926e9cd..8a365958 100644
--- a/doc/help/combine.rst
+++ b/doc/help/combine.rst
@@ -1,4 +1,6 @@
+.. This file is auto-generated by "make dochtml", don't edit it manually.
+
.. code::
$ coverage combine --help
diff --git a/doc/help/debug.rst b/doc/help/debug.rst
index db1e64b2..b6361da5 100644
--- a/doc/help/debug.rst
+++ b/doc/help/debug.rst
@@ -1,4 +1,6 @@
+.. This file is auto-generated by "make dochtml", don't edit it manually.
+
.. code::
$ coverage debug --help
diff --git a/doc/help/erase.rst b/doc/help/erase.rst
index c8f45155..372dd4fb 100644
--- a/doc/help/erase.rst
+++ b/doc/help/erase.rst
@@ -1,4 +1,6 @@
+.. This file is auto-generated by "make dochtml", don't edit it manually.
+
.. code::
$ coverage erase --help
diff --git a/doc/help/html.rst b/doc/help/html.rst
index 8dfa285a..7dbf91c8 100644
--- a/doc/help/html.rst
+++ b/doc/help/html.rst
@@ -1,4 +1,6 @@
+.. This file is auto-generated by "make dochtml", don't edit it manually.
+
.. code::
$ coverage html --help
diff --git a/doc/help/json.rst b/doc/help/json.rst
index cec488e5..a330167e 100644
--- a/doc/help/json.rst
+++ b/doc/help/json.rst
@@ -1,4 +1,6 @@
+.. This file is auto-generated by "make dochtml", don't edit it manually.
+
.. code::
$ coverage json --help
diff --git a/doc/help/report.rst b/doc/help/report.rst
index 3408f2bb..b8985e4b 100644
--- a/doc/help/report.rst
+++ b/doc/help/report.rst
@@ -1,4 +1,6 @@
+.. This file is auto-generated by "make dochtml", don't edit it manually.
+
.. code::
$ coverage report --help
diff --git a/doc/help/run.rst b/doc/help/run.rst
index a336929a..f71a0956 100644
--- a/doc/help/run.rst
+++ b/doc/help/run.rst
@@ -1,4 +1,6 @@
+.. This file is auto-generated by "make dochtml", don't edit it manually.
+
.. code::
$ coverage run --help
diff --git a/doc/help/xml.rst b/doc/help/xml.rst
index eb52750d..2ad134c9 100644
--- a/doc/help/xml.rst
+++ b/doc/help/xml.rst
@@ -1,4 +1,6 @@
+.. This file is auto-generated by "make dochtml", don't edit it manually.
+
.. code::
$ coverage xml --help