docs: Consistently use SPDX identifiers
authorTimothée Ravier <tim@siosm.fr>
Tue, 20 Feb 2024 16:04:01 +0000 (17:04 +0100)
committerTimothée Ravier <tim@siosm.fr>
Tue, 20 Feb 2024 16:04:02 +0000 (17:04 +0100)
Standardize on a single SPDX identifier in a comment at the top.

20 files changed:
docs/CONTRIBUTING.md
docs/README-historical.md
docs/README.md
docs/adapting-existing.md
docs/atomic-rollbacks.md
docs/atomic-upgrades.md
docs/authenticated-repos.md
docs/bootloaders.md
docs/buildsystem-and-repos.md
docs/composefs.md
docs/contributing-tutorial.md
docs/deployment.md
docs/formats.md
docs/ima.md
docs/index.md
docs/introduction.md
docs/related-projects.md
docs/repo.md
docs/repository-management.md
docs/var.md

index 8ee1fdcc79edb37b67d8987e8a1fa110923b2c29..b41e9484911247f14802593e89395553a95f6daf 100644 (file)
@@ -1,6 +1,7 @@
 ---
 nav_order: 190
 ---
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # Contributing
 {: .no_toc }
index eba0960f15abd00fcfa850ad08378c3cfec77c84..f185e86509e835b7d2e77a2094c54189c5b88ce6 100644 (file)
@@ -2,6 +2,7 @@
 nav_order: 990
 title: Historical OSTree README
 ---
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 **This file is outdated, but some of the text here is still useful for
 historical context.  I'm preserving it (explicitly still in the tree)
index f1f89ecb3942b8de8f2d4f372e53c928d2f5d76c..b19db00a883a0afa0bdaf249f9e239fe5c5d2c07 100644 (file)
@@ -1,3 +1,5 @@
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
+
 This documentation is written in [Jekyll](https://jekyllrb.com/) format
 to be published on [GitHub Pages](https://pages.github.com/). The
 rendered HTML will be automatically built and published, but you can
index 422ba498ccd8daccc6ee8082e26e7478d153774f..c477fb14fffdaa4ae6d01499f2ddd022eb3f5314 100644 (file)
@@ -1,6 +1,7 @@
 ---
 nav_order: 70
 ---
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # Adapting existing mainstream distributions
 {: .no_toc }
@@ -200,6 +201,3 @@ Then to actually deploy this tree for the next boot:
 
 This is essentially what [rpm-ostree](https://github.com/projectatomic/rpm-ostree/)
 does to support its [package layering model](https://rpm-ostree.readthedocs.io/en/latest/manual/administrator-handbook/#hybrid-imagepackaging-via-package-layering).
-
-###### Licensing for this document:
-`SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later)`
index 61405663e4a8d1a2d7c293e43ee205295c27b8eb..89e882b4733984dd2853995830d496dc02112b5f 100644 (file)
@@ -1,6 +1,7 @@
 ---
 nav_order: 60
 ---
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # Atomic Rollbacks
 {: .no_toc }
@@ -171,6 +172,3 @@ ExecStart=/usr/sbin/ostree-rollback-to-rescue
 [Install]
 WantedBy=sysinit.target
 ```
-
-###### Licensing for this document:
-`SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later)`
index 414bdccd7b0d4a14e848fe202fd0e0fe5be401e9..777a1fa00435d71f7b0e753e866c7764f967912a 100644 (file)
@@ -1,6 +1,7 @@
 ---
 nav_order: 50
 ---
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # Atomic Upgrades
 {: .no_toc }
@@ -140,6 +141,3 @@ so just like `/boot`, it has a version of `0` or `1` appended.
 Each bootloader entry has a special `ostree=` argument which refers to
 one of these symbolic links.  This is parsed at runtime in the
 initramfs.
-
-###### Licensing for this document:
-`SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later)`
index 65d360acc1571cdacb8bcef3ddd87791224d969c..491a33a3975c2fd98a6938b6cc70dfcda456fabe 100644 (file)
@@ -1,6 +1,7 @@
 ---
 nav_order: 100
 ---
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # Handling access to authenticated remote repositories
 {: .no_toc }
index b93b18c6ca6f196476e31247f5d618dec4b90209..03e017915a027416857d2a7f725a14725ea83fa2 100644 (file)
@@ -1,6 +1,7 @@
 ---
 nav_order: 120
 ---
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # Bootloaders
 {: .no_toc }
index 5c57813111f8b26d101fdcab91b12fb3c52f1c8b..6141d83baf0fc7b907e2880ce6279d8cccb33033 100644 (file)
@@ -1,6 +1,7 @@
 ---
 nav_order: 90
 ---
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # Writing a buildsystem and managing repositories
 {: .no_toc }
@@ -191,6 +192,3 @@ ostree --repo=repo static-delta generate exampleos/x86_64/standard
 
 Next, see [Repository Management](repository-management.md) for the
 next steps in managing content in OSTree repositories.
-
-###### Licensing for this document:
-`SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later)`
index 528141a375ae198a35e4ab983c1f5f16c0b801eb..54469a9b20f7754e1412c702805ae5f8ca274574 100644 (file)
@@ -1,6 +1,7 @@
 ---
 nav_order: 110
 ---
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # Using composefs with OSTree
 {: .no_toc }
@@ -113,6 +114,3 @@ provides much stronger and more efficient integrity:
 
 - https://github.com/containers/composefs
 - https://www.kernel.org/doc/html/next/filesystems/fsverity.html
-
-<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
-
index 3341ad9009bac1b588944906a3bc37488d7d0d12..d2972297b0009990f1f62a608e83af9f61148d63 100644 (file)
@@ -1,6 +1,7 @@
 ---
 nav_order: 200
 ---
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # OSTree Contributing Tutorial
 {: .no_toc }
index 7df292d5a7f9222ab3f17e93ec6cff5786fa2f30..d9c44c7aa19cfef19455350cf4b1f3660aa20f52 100644 (file)
@@ -1,6 +1,7 @@
 ---
 nav_order: 40
 ---
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # Deployments
 {: .no_toc }
@@ -124,6 +125,3 @@ deployment.
 At present, not all bootloaders implement the BootLoaderSpec, so
 OSTree contains code for some of these to regenerate native config
 files (such as `/boot/syslinux/syslinux.conf`) based on the entries.
-
-###### Licensing for this document:
-`SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later)`
index 74be428fd0194681213820e8840fff41328afb8c..e607b9864b687cdd131d9f2b4e490456b1803eca 100644 (file)
@@ -1,6 +1,7 @@
 ---
 nav_order: 80
 ---
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # OSTree data formats
 {: .no_toc }
@@ -204,6 +205,3 @@ For these types of objects, the delta superblock contains an array of
 "fallback objects".  These objects aren't included in the delta
 parts - the client simply fetches them from the underlying `.filez`
 object.
-
-###### Licensing for this document:
-`SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later)`
index bebb3817ff50ea3c82bccd3a205526ff59b2b9b9..fc7daf99ee2c38aeb4d8160a32ddc99d99dd4ad9 100644 (file)
@@ -1,6 +1,7 @@
 ---
 nav_order: 110
 ---
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # Using Linux IMA with OSTree
 {: .no_toc }
@@ -110,6 +111,3 @@ signing commits with these "portable" EVM signatures in addition to IMA.
 - https://wiki.gentoo.org/wiki/Integrity_Measurement_Architecture
 - https://fedoraproject.org/wiki/Changes/Signed_RPM_Contents
 - https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html/managing_monitoring_and_updating_the_kernel/enhancing-security-with-the-kernel-integrity-subsystem_managing-monitoring-and-updating-the-kernel
-
-<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
-
index 23dfe57ed661eda27c6100d4bed751ff259dc6f2..c28d9e58b4e19cb1e167b293b92b09d9e5cf3dde 100644 (file)
@@ -1,6 +1,7 @@
 ---
 nav_order: 10
 ---
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # libostree
 {: .no_toc }
index df64b5850a12ebaa0d5dbe64d31fadcfd8652612..855cded94594c331e12398a2e640f37616f0038f 100644 (file)
@@ -1,6 +1,7 @@
 ---
 nav_order: 20
 ---
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # OSTree Overview
 {: .no_toc }
@@ -186,6 +187,3 @@ Finally, each deployment has its own writable copy of the
 configuration store `/etc`.  On upgrade, OSTree will
 perform a basic 3-way diff, and apply any local changes to the
 new copy, while leaving the old untouched.
-
-###### Licensing for this document:
-`SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later)`
index 7eb464ccc2808b929023a4a69546799180705f6a..e4c21185d2158be7d0e45b2cb7bee94ecaec6996 100644 (file)
@@ -1,6 +1,7 @@
 ---
 nav_order: 110
 ---
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # Related Projects
 {: .no_toc }
@@ -388,6 +389,3 @@ as the tool abstracts the handling of OSTree concepts from the final users.
 [Torizon Cloud](https://developer.toradex.com/torizon/torizon-platform/torizon-platform-services-overview/)
 is a hosted OTA update system that provides OS updates to Torizon OS using
 OSTree and Aktualizr.
-
-###### Licensing for this document:
-`SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later)`
index 31e6d809d040b60e88e422b1b004fe396efca02c..a5c746ef8982b9fc44f1e4be429f478baafdef4e 100644 (file)
@@ -1,6 +1,7 @@
 ---
 nav_order: 30
 ---
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # Anatomy of an OSTree repository
 {: .no_toc }
@@ -183,6 +184,3 @@ the only way to provide GPG signatures (transitively) on deltas.
 If a repository administrator creates a summary file, they must
 thereafter run `ostree summary -u` to update it whenever a ref is
 updated or a static delta is generated.
-
-###### Licensing for this document:
-`SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later)`
index 9760bf690a500c2ca48929b116b2970dda31484c..07594f531024bf1c0919ce292176731aa3948a9c 100644 (file)
@@ -1,6 +1,7 @@
 ---
 nav_order: 100
 ---
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # Managing content in OSTree repositories
 {: .no_toc }
@@ -268,6 +269,3 @@ $ ostree --repo=/path/to/repo summary -u
 ```
 
 After that, clients fetching that commit will prefer fetching the "scratch" delta if they don't have the original ref.
-
-###### Licensing for this document:
-`SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later)`
index 90c119805fc8c8f0685ef360b20ffd2099c31c6e..44ee375eec5414751733436f553297db13784e70 100644 (file)
@@ -1,6 +1,7 @@
 ---
 nav_order: 70
 ---
+<!-- SPDX-License-Identifier: (CC-BY-SA-3.0 OR GFDL-1.3-or-later) -->
 
 # OSTree and /var handling