diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 2f266f2934..ea15325fe9 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -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. diff --git a/doc/BOOT_LOADER_SPECIFICATION.md b/docs/BOOT_LOADER_SPECIFICATION.md similarity index 100% rename from doc/BOOT_LOADER_SPECIFICATION.md rename to docs/BOOT_LOADER_SPECIFICATION.md diff --git a/doc/CGROUP_DELEGATION.md b/docs/CGROUP_DELEGATION.md similarity index 100% rename from doc/CGROUP_DELEGATION.md rename to docs/CGROUP_DELEGATION.md diff --git a/doc/CODE_QUALITY.md b/docs/CODE_QUALITY.md similarity index 100% rename from doc/CODE_QUALITY.md rename to docs/CODE_QUALITY.md diff --git a/doc/CODING_STYLE b/docs/CODING_STYLE similarity index 100% rename from doc/CODING_STYLE rename to docs/CODING_STYLE diff --git a/doc/DISTRO_PORTING b/docs/DISTRO_PORTING similarity index 100% rename from doc/DISTRO_PORTING rename to docs/DISTRO_PORTING diff --git a/doc/ENVIRONMENT.md b/docs/ENVIRONMENT.md similarity index 100% rename from doc/ENVIRONMENT.md rename to docs/ENVIRONMENT.md diff --git a/doc/HACKING b/docs/HACKING similarity index 97% rename from doc/HACKING rename to docs/HACKING index 182b0bac8c..c7b700e6a7 100644 --- a/doc/HACKING +++ b/docs/HACKING @@ -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 diff --git a/doc/PORTABLE_SERVICES.md b/docs/PORTABLE_SERVICES.md similarity index 100% rename from doc/PORTABLE_SERVICES.md rename to docs/PORTABLE_SERVICES.md diff --git a/doc/TRANSIENT-SETTINGS.md b/docs/TRANSIENT-SETTINGS.md similarity index 100% rename from doc/TRANSIENT-SETTINGS.md rename to docs/TRANSIENT-SETTINGS.md diff --git a/doc/TRANSLATORS b/docs/TRANSLATORS similarity index 100% rename from doc/TRANSLATORS rename to docs/TRANSLATORS diff --git a/doc/UIDS-GIDS.md b/docs/UIDS-GIDS.md similarity index 100% rename from doc/UIDS-GIDS.md rename to docs/UIDS-GIDS.md diff --git a/doc/sysvinit/README.in b/docs/sysvinit/README.in similarity index 100% rename from doc/sysvinit/README.in rename to docs/sysvinit/README.in diff --git a/doc/sysvinit/meson.build b/docs/sysvinit/meson.build similarity index 100% rename from doc/sysvinit/meson.build rename to docs/sysvinit/meson.build diff --git a/doc/var-log/README.in b/docs/var-log/README.in similarity index 100% rename from doc/var-log/README.in rename to docs/var-log/README.in diff --git a/doc/var-log/meson.build b/docs/var-log/meson.build similarity index 100% rename from doc/var-log/meson.build rename to docs/var-log/meson.build diff --git a/meson.build b/meson.build index 48a47f8103..2b64bcb333 100644 --- a/meson.build +++ b/meson.build @@ -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)