From c9a341902b1d678585191dc0f90307987e7bf7e1 Mon Sep 17 00:00:00 2001 From: Desmond Obisi <51109125+DesmondSanctity@users.noreply.github.com> Date: Wed, 13 Jul 2022 21:46:04 +0100 Subject: [PATCH] Document choice to use Ansible Project in copyright lines (#78164) Co-authored-by: Sviatoslav Sydorenko --- .../developing_modules_documenting.rst | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) diff --git a/docs/docsite/rst/dev_guide/developing_modules_documenting.rst b/docs/docsite/rst/dev_guide/developing_modules_documenting.rst index c8f37e4a8d6..9bd9cbd461a 100644 --- a/docs/docsite/rst/dev_guide/developing_modules_documenting.rst +++ b/docs/docsite/rst/dev_guide/developing_modules_documenting.rst @@ -33,28 +33,24 @@ Begin your Ansible module with ``#!/usr/bin/python`` - this "shebang" allows ``a Copyright and license ===================== -After the shebang and UTF-8 coding, add a `copyright line `_ with the original copyright holder and a license declaration. The license declaration should be ONLY one line, not the full GPL prefix.: +After the shebang and UTF-8 coding, add a `copyright line `_ with the original copyright holder and a license declaration. The license declaration should be ONLY one line, not the full GPL prefix.: .. code-block:: python #!/usr/bin/python # -*- coding: utf-8 -*- - # Copyright: (c) 2018, Terry Jones + # Copyright: Contributors to the Ansible project # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) -Major additions to the module (for instance, rewrites) may add additional copyright lines. Any legal review will include the source control history, so an exhaustive copyright header is not necessary. -Please do not edit the existing copyright year. This simplifies project administration and is unlikely to cause any interesting legal issues. -When adding a second copyright line for a significant feature or rewrite, add the newer line above the older one: +Additions to the module (for instance, rewrites) are not permitted to add additional copyright lines other than the default copyright statement if missing: .. code-block:: python - #!/usr/bin/python - # -*- coding: utf-8 -*- - - # Copyright: (c) 2017, [New Contributor(s)] - # Copyright: (c) 2015, [Original Contributor(s)] - # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + # Copyright: Contributors to the Ansible project + +Any legal review will include the source control history, so an exhaustive copyright header is not necessary. +Please do not include a copyright year. If the existing copyright statement includes a year, do not edit the existing copyright year. Any existing copyright header should not be modified without permission from the copyright author. .. _ansible_metadata_block: