]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
docs: move doc/ to docs/
authorFilipe Brandenburger <filbranden@google.com>
Fri, 7 Sep 2018 08:02:42 +0000 (01:02 -0700)
committerFilipe Brandenburger <filbranden@google.com>
Sat, 8 Sep 2018 20:39:03 +0000 (13:39 -0700)
The docs/ directory is special in GitHub, since it can be used to serve GitHub
Pages from, so there's a benefit to switching to it in order to expose it
directly as a website.

Updated references to it from the documentations themselves, from the
CONTRIBUTING.md file and from Meson build files.

17 files changed:
.github/CONTRIBUTING.md
docs/BOOT_LOADER_SPECIFICATION.md [moved from doc/BOOT_LOADER_SPECIFICATION.md with 100% similarity]
docs/CGROUP_DELEGATION.md [moved from doc/CGROUP_DELEGATION.md with 100% similarity]
docs/CODE_QUALITY.md [moved from doc/CODE_QUALITY.md with 100% similarity]
docs/CODING_STYLE [moved from doc/CODING_STYLE with 100% similarity]
docs/DISTRO_PORTING [moved from doc/DISTRO_PORTING with 100% similarity]
docs/ENVIRONMENT.md [moved from doc/ENVIRONMENT.md with 100% similarity]
docs/HACKING [moved from doc/HACKING with 97% similarity]
docs/PORTABLE_SERVICES.md [moved from doc/PORTABLE_SERVICES.md with 100% similarity]
docs/TRANSIENT-SETTINGS.md [moved from doc/TRANSIENT-SETTINGS.md with 100% similarity]
docs/TRANSLATORS [moved from doc/TRANSLATORS with 100% similarity]
docs/UIDS-GIDS.md [moved from doc/UIDS-GIDS.md with 100% similarity]
docs/sysvinit/README.in [moved from doc/sysvinit/README.in with 100% similarity]
docs/sysvinit/meson.build [moved from doc/sysvinit/meson.build with 100% similarity]
docs/var-log/README.in [moved from doc/var-log/README.in with 100% similarity]
docs/var-log/meson.build [moved from doc/var-log/meson.build with 100% similarity]
meson.build

index 2f266f2934b7e2b552c89f6e9ed171d1b390874e..ea15325fe95bc8b153d85e8c7ad19eb877e6c425 100644 (file)
@@ -24,8 +24,8 @@ If you discover a security vulnerability, we'd appreciate a non-public disclosur
 ## Posting Pull Requests
 
 * Make sure to post PRs only relative to a very recent git master.
-* Follow our [Coding Style](https://raw.githubusercontent.com/systemd/systemd/master/doc/CODING_STYLE) when contributing code. This is a requirement for all code we merge.
-* Please make sure to test your change before submitting the PR. See [HACKING](https://raw.githubusercontent.com/systemd/systemd/master/doc/HACKING) for details how to do this.
+* Follow our [Coding Style](https://raw.githubusercontent.com/systemd/systemd/master/docs/CODING_STYLE) when contributing code. This is a requirement for all code we merge.
+* Please make sure to test your change before submitting the PR. See [HACKING](https://raw.githubusercontent.com/systemd/systemd/master/docs/HACKING) for details how to do this.
 * Make sure to run the test suite locally, before posting your PR. We use a CI system, meaning we don't even look at your PR, if the build and tests don't pass.
 * If you need to update the code in an existing PR, force-push into the same branch, overriding old commits with new versions.
 * After you have pushed a new version, add a comment about the new version (no notification is sent just for the commits, so it's easy to miss the update without an explicit comment). If you are a member of the systemd project on GitHub, remove the `reviewed/needs-rework` label.
similarity index 100%
rename from doc/CODE_QUALITY.md
rename to docs/CODE_QUALITY.md
similarity index 100%
rename from doc/CODING_STYLE
rename to docs/CODING_STYLE
similarity index 100%
rename from doc/DISTRO_PORTING
rename to docs/DISTRO_PORTING
similarity index 100%
rename from doc/ENVIRONMENT.md
rename to docs/ENVIRONMENT.md
similarity index 97%
rename from doc/HACKING
rename to docs/HACKING
index 182b0bac8ccb58eb4ebd2a111bf68659cdbfa8af..c7b700e6a70f85915b1ba56fd8dd56e75b93d93a 100644 (file)
@@ -7,7 +7,7 @@ Request (PR):
         https://github.com/systemd/systemd/pull/new
 
 Please make sure to follow our Coding Style when submitting patches. See
-doc/CODING_STYLE for details. Also have a look at our Contribution Guidelines:
+docs/CODING_STYLE for details. Also have a look at our Contribution Guidelines:
 
         https://github.com/systemd/systemd/blob/master/.github/CONTRIBUTING.md
 
@@ -23,7 +23,7 @@ encouraged.
 Please also have a look at our list of code quality tools we have setup for systemd,
 to ensure our codebase stays in good shape:
 
-        https://github.com/systemd/systemd/blob/master/doc/CODE_QUALITY.md
+        https://github.com/systemd/systemd/blob/master/docs/CODE_QUALITY.md
 
 Please always test your work before submitting a PR. For many of the components
 of systemd testing is straight-forward as you can simply compile systemd and
similarity index 100%
rename from doc/TRANSLATORS
rename to docs/TRANSLATORS
similarity index 100%
rename from doc/UIDS-GIDS.md
rename to docs/UIDS-GIDS.md
similarity index 100%
rename from doc/var-log/README.in
rename to docs/var-log/README.in
index 48a47f8103a7172241ece96dd53ac86ea9f3e8da..2b64bcb33307f3fd6a5ba0222153903a4f9d84b3 100644 (file)
@@ -2749,8 +2749,8 @@ subdir('network')
 subdir('man')
 subdir('shell-completion/bash')
 subdir('shell-completion/zsh')
-subdir('doc/sysvinit')
-subdir('doc/var-log')
+subdir('docs/sysvinit')
+subdir('docs/var-log')
 
 # FIXME: figure out if the warning is true:
 # https://github.com/mesonbuild/meson/wiki/Reference-manual#install_subdir
@@ -2766,13 +2766,13 @@ install_data('LICENSE.GPL2',
              'LICENSE.LGPL2.1',
              'NEWS',
              'README',
-             'doc/CODING_STYLE',
-             'doc/DISTRO_PORTING',
-             'doc/ENVIRONMENT.md',
-             'doc/HACKING',
-             'doc/TRANSIENT-SETTINGS.md',
-             'doc/TRANSLATORS',
-             'doc/UIDS-GIDS.md',
+             'docs/CODING_STYLE',
+             'docs/DISTRO_PORTING',
+             'docs/ENVIRONMENT.md',
+             'docs/HACKING',
+             'docs/TRANSIENT-SETTINGS.md',
+             'docs/TRANSLATORS',
+             'docs/UIDS-GIDS.md',
              'src/libsystemd/sd-bus/GVARIANT-SERIALIZATION',
              install_dir : docdir)