proxmox-mirrors/mirror_frr
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_frr synced 2025-04-29 02:37:00 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: update workflow docs for SPDX header

Browse Source 
Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
This commit is contained in:
David Lamparter 2023-02-09 12:41:55 +01:00
parent cca918fe04
commit 0d60d63f94
1 changed files with 22 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
doc/developer/workflow.rst
View File

@ -671,33 +671,36 @@ above) added to the file. The header should be:
.. code-block:: c
// SPDX-License-Identifier: GPL-2.0-or-later
/*
* Title/Function of file
* Copyright (C) YEAR Author’s Name
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the Free
* Software Foundation; either version 2 of the License, or (at your option)
* any later version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; see the file COPYING; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#include <zebra.h>
Please copy-paste this header verbatim. In particular:
A ``SPDX-License-Identifier`` header is required in all source files, i.e.
``.c``, ``.h``, ``.cpp`` and ``.py`` files. The license boilerplate should be
removed in these files. Some existing files are missing this header, this is
slowly being fixed.
A ``SPDX-License-Identifier`` header *and* the full license boilerplate is
required in schema definition files, i.e. ``.yang`` and ``.proto``. The
rationale for this is that these files are likely to be individually copied to
places outside FRR, and having only the SPDX header would become a "dangling
pointer".
.. warning::
**DO NOT REMOVE A "Copyright" LINE OR AUTHOR NAME, EVER.**
**DO NOT APPLY AN SPDX HEADER WHEN THE LICENSE IS UNCLEAR, UNLESS YOU HAVE
CHECKED WITH *ALL* SIGNIFICANT AUTHORS.**
Please to keep ``#include <zebra.h>``. The absolute first header included in
any C file **must** be either ``zebra.h`` or ``config.h`` (with HAVE_CONFIG_H
guard.)
- Do not replace "This program" with "FRR"
- Do not change the address of the FSF
- keep ``#include <zebra.h>``. The absolute first header included in any C
file **must** be either ``zebra.h`` or ``config.h`` (with HAVE_CONFIG_H guard)
Adding Copyright Claims to Existing Files
-----------------------------------------