From: Timothée Ravier Date: Tue, 20 Feb 2024 16:04:01 +0000 (+0100) Subject: docs: Consistently use SPDX identifiers X-Git-Tag: archive/raspbian/2024.8-1+rpi1^2~7^2~4^2~4^2~2 X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=1ce6216625bf0f9f08cb008d7b9e2eb9c3f47b55;p=ostree.git docs: Consistently use SPDX identifiers Standardize on a single SPDX identifier in a comment at the top. --- diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 8ee1fdcc..b41e9484 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -1,6 +1,7 @@ --- nav_order: 190 --- + # Contributing {: .no_toc } diff --git a/docs/README-historical.md b/docs/README-historical.md index eba0960f..f185e865 100644 --- a/docs/README-historical.md +++ b/docs/README-historical.md @@ -2,6 +2,7 @@ nav_order: 990 title: Historical OSTree README --- + **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) diff --git a/docs/README.md b/docs/README.md index f1f89ecb..b19db00a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,3 +1,5 @@ + + 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 diff --git a/docs/adapting-existing.md b/docs/adapting-existing.md index 422ba498..c477fb14 100644 --- a/docs/adapting-existing.md +++ b/docs/adapting-existing.md @@ -1,6 +1,7 @@ --- nav_order: 70 --- + # 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)` diff --git a/docs/atomic-rollbacks.md b/docs/atomic-rollbacks.md index 61405663..89e882b4 100644 --- a/docs/atomic-rollbacks.md +++ b/docs/atomic-rollbacks.md @@ -1,6 +1,7 @@ --- nav_order: 60 --- + # 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)` diff --git a/docs/atomic-upgrades.md b/docs/atomic-upgrades.md index 414bdccd..777a1fa0 100644 --- a/docs/atomic-upgrades.md +++ b/docs/atomic-upgrades.md @@ -1,6 +1,7 @@ --- nav_order: 50 --- + # 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)` diff --git a/docs/authenticated-repos.md b/docs/authenticated-repos.md index 65d360ac..491a33a3 100644 --- a/docs/authenticated-repos.md +++ b/docs/authenticated-repos.md @@ -1,6 +1,7 @@ --- nav_order: 100 --- + # Handling access to authenticated remote repositories {: .no_toc } diff --git a/docs/bootloaders.md b/docs/bootloaders.md index b93b18c6..03e01791 100644 --- a/docs/bootloaders.md +++ b/docs/bootloaders.md @@ -1,6 +1,7 @@ --- nav_order: 120 --- + # Bootloaders {: .no_toc } diff --git a/docs/buildsystem-and-repos.md b/docs/buildsystem-and-repos.md index 5c578131..6141d83b 100644 --- a/docs/buildsystem-and-repos.md +++ b/docs/buildsystem-and-repos.md @@ -1,6 +1,7 @@ --- nav_order: 90 --- + # 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)` diff --git a/docs/composefs.md b/docs/composefs.md index 528141a3..54469a9b 100644 --- a/docs/composefs.md +++ b/docs/composefs.md @@ -1,6 +1,7 @@ --- nav_order: 110 --- + # 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 - - - diff --git a/docs/contributing-tutorial.md b/docs/contributing-tutorial.md index 3341ad90..d2972297 100644 --- a/docs/contributing-tutorial.md +++ b/docs/contributing-tutorial.md @@ -1,6 +1,7 @@ --- nav_order: 200 --- + # OSTree Contributing Tutorial {: .no_toc } diff --git a/docs/deployment.md b/docs/deployment.md index 7df292d5..d9c44c7a 100644 --- a/docs/deployment.md +++ b/docs/deployment.md @@ -1,6 +1,7 @@ --- nav_order: 40 --- + # 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)` diff --git a/docs/formats.md b/docs/formats.md index 74be428f..e607b986 100644 --- a/docs/formats.md +++ b/docs/formats.md @@ -1,6 +1,7 @@ --- nav_order: 80 --- + # 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)` diff --git a/docs/ima.md b/docs/ima.md index bebb3817..fc7daf99 100644 --- a/docs/ima.md +++ b/docs/ima.md @@ -1,6 +1,7 @@ --- nav_order: 110 --- + # 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 - - - diff --git a/docs/index.md b/docs/index.md index 23dfe57e..c28d9e58 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,7 @@ --- nav_order: 10 --- + # libostree {: .no_toc } diff --git a/docs/introduction.md b/docs/introduction.md index df64b585..855cded9 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -1,6 +1,7 @@ --- nav_order: 20 --- + # 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)` diff --git a/docs/related-projects.md b/docs/related-projects.md index 7eb464cc..e4c21185 100644 --- a/docs/related-projects.md +++ b/docs/related-projects.md @@ -1,6 +1,7 @@ --- nav_order: 110 --- + # 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)` diff --git a/docs/repo.md b/docs/repo.md index 31e6d809..a5c746ef 100644 --- a/docs/repo.md +++ b/docs/repo.md @@ -1,6 +1,7 @@ --- nav_order: 30 --- + # 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)` diff --git a/docs/repository-management.md b/docs/repository-management.md index 9760bf69..07594f53 100644 --- a/docs/repository-management.md +++ b/docs/repository-management.md @@ -1,6 +1,7 @@ --- nav_order: 100 --- + # 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)` diff --git a/docs/var.md b/docs/var.md index 90c11980..44ee375e 100644 --- a/docs/var.md +++ b/docs/var.md @@ -1,6 +1,7 @@ --- nav_order: 70 --- + # OSTree and /var handling