From bd4c735b15f76cfb59a4e4d30f4c41c3c1930f59 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Apitzsch?= Date: Thu, 4 Jul 2024 13:54:47 +0200 Subject: [PATCH] doc: Add SPDX license guidelines --- doc/contributing/source/coding-style.rst | 15 ++---------- doc/contributing/source/general.rst | 8 ++----- doc/tutorial/source/conceptual-overview.rst | 13 +---------- doc/tutorial/source/tracing.rst | 26 ++------------------- 4 files changed, 7 insertions(+), 55 deletions(-) diff --git a/doc/contributing/source/coding-style.rst b/doc/contributing/source/coding-style.rst index dfc8a5872..726ef2ca1 100644 --- a/doc/contributing/source/coding-style.rst +++ b/doc/contributing/source/coding-style.rst @@ -649,18 +649,7 @@ statement. /* * Copyright (c) YEAR COPYRIGHTHOLDER * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License version 2 as - * published by the Free Software Foundation; - * - * 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; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * SPDX-License-Identifier: GPL-2.0-only * * Author: MyName */ @@ -719,7 +708,7 @@ The ``my-class.cc`` file is structured similarly: /* * Copyright (c) YEAR COPYRIGHTHOLDER * - * 3-paragraph GPL blurb + * SPDX-License-Identifier: GPL-2.0-only * * Author: MyName */ diff --git a/doc/contributing/source/general.rst b/doc/contributing/source/general.rst index 3fb1bba09..71389086b 100644 --- a/doc/contributing/source/general.rst +++ b/doc/contributing/source/general.rst @@ -98,9 +98,7 @@ An example placement of a copyright statement can be found in the file /* * Copyright (c) 2005,2006 INRIA * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License version 2 as - * published by the Free Software Foundation; + * SPDX-License-Identifier: GPL-2.0-only Copyright on existing files =========================== @@ -115,9 +113,7 @@ of code that is covered by the new copyright. An example is the program * Copyright (c) 2010 TELEMATICS LAB, DEE - Politecnico di Bari * Copyright (c) 2018 Fraunhofer ESK : RLF extensions * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License version 2 as - * published by the Free Software Foundation; + * SPDX-License-Identifier: GPL-2.0-only Here, Fraunhofer ESK added extensions to support radio link failure (RLF), and the copyright statement clarifies the extension (separated from the diff --git a/doc/tutorial/source/conceptual-overview.rst b/doc/tutorial/source/conceptual-overview.rst index fb24257ab..dd5dbcc68 100644 --- a/doc/tutorial/source/conceptual-overview.rst +++ b/doc/tutorial/source/conceptual-overview.rst @@ -179,18 +179,7 @@ text and an author listed below. :: /* - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License version 2 as - * published by the Free Software Foundation; - * - * 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; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * SPDX-License-Identifier: GPL-2.0-only */ Module Includes diff --git a/doc/tutorial/source/tracing.rst b/doc/tutorial/source/tracing.rst index bd3d2c906..bda23e2fa 100644 --- a/doc/tutorial/source/tracing.rst +++ b/doc/tutorial/source/tracing.rst @@ -314,18 +314,7 @@ example of tracing that can be assembled. You can find this code in the tutorial directory as ``fourth.cc``. Let's walk through it:: /* - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License version 2 as - * published by the Free Software Foundation; - * - * 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; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * SPDX-License-Identifier: GPL-2.0-only */ #include "ns3/object.h" @@ -1390,18 +1379,7 @@ dissecting the congestion window test. Open see some familiar looking code:: /* - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License version 2 as - * published by the Free Software Foundation; - * - * 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; if not, write to the Free Software - * Foundation, Include., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * SPDX-License-Identifier: GPL-2.0-only */ #include "tutorial-app.h"