doc: add a new doc/ directory, and move two markdown docs into them

I figure sooneror later we'll have more of these docs, hence let's give
them a clean place to be.

This leaves NEWS and README/README.md as well as the LICENSE texts in
the root directory of the project since that appears to be customary for
Free Software projects.

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 6f197441cb30dc13352937fd33f968de5cd683c7..2f266f2934b7e2b552c89f6e9ed171d1b390874e 100644 (file)
--- 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/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/HACKING) for details how to do this.
+* 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.
 * 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/NEWS b/NEWS
index 22372a82960ff6834c57717368b4b60c13403da2..f5e348cc4c0010db96856dab37ab4af1e30b3514 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -373,8 +373,8 @@ CHANGES WITH 236:
           store again, ahead of POLLHUP or POLLERR when they are removed
           anyway.
 
-        * A new document UIDS-GIDS.md has been added to the source tree, that
-          documents the UID/GID range and assignment assumptions and
+        * A new document doc/UIDS-GIDS.md has been added to the source tree,
+          that documents the UID/GID range and assignment assumptions and
           requirements of systemd.
 
         * The watchdog device PID 1 will ping may now be configured through the
@@ -1106,7 +1106,7 @@ CHANGES WITH 233:
         * Documentation has been added that lists all of systemd's low-level
           environment variables:
 
-          https://github.com/systemd/systemd/blob/master/ENVIRONMENT.md
+          https://github.com/systemd/systemd/blob/master/doc/ENVIRONMENT.md
 
         * sd-daemon gained a new API sd_is_socket_sockaddr() for determining
           whether a specific socket file descriptor matches a specified socket
@@ -1817,7 +1817,7 @@ CHANGES WITH 231:
           booted up with "systemd-nspawn -b -i", qemu-kvm or on any physical
           UEFI PC. This functionality is particularly useful to easily test
           local changes made to systemd in a pristine, defined environment. See
-          HACKING for details.
+          doc/HACKING for details.
 
         * configure learned the --with-support-url= option to specify the
           distribution's bugtracker.

diff --git a/README.md b/README.md
index 06fd69142a7853a5ea3588b04b329184439e6c97..4b017faf1b29d798fab99729e37eba0f5bbd041c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -14,10 +14,10 @@ Information about build requirements are provided in the [README file](../master
 
 Consult our [NEWS file](../master/NEWS) for information about what's new in the most recent systemd versions.
 
-Please see the [HACKING file](../master/HACKING) for information how to hack on systemd and test your modifications.
+Please see the [HACKING file](../master/doc/HACKING) for information how to hack on systemd and test your modifications.
 
 Please see our [Contribution Guidelines](../master/.github/CONTRIBUTING.md) for more information about filing GitHub Issues and posting GitHub Pull Requests.
 
-When preparing patches for systemd, please follow our [Coding Style Guidelines](../master/CODING_STYLE).
+When preparing patches for systemd, please follow our [Coding Style Guidelines](../master/doc/CODING_STYLE).
 
 If you are looking for support, please contact our [mailing list](https://lists.freedesktop.org/mailman/listinfo/systemd-devel) or join our [IRC channel](irc://irc.freenode.org/%23systemd).

diff --git a/CODING_STYLE b/doc/CODING_STYLE
similarity index 100%
rename from CODING_STYLE
rename to doc/CODING_STYLE

diff --git a/DISTRO_PORTING b/doc/DISTRO_PORTING
similarity index 100%
rename from DISTRO_PORTING
rename to doc/DISTRO_PORTING

diff --git a/ENVIRONMENT.md b/doc/ENVIRONMENT.md
similarity index 100%
rename from ENVIRONMENT.md
rename to doc/ENVIRONMENT.md

diff --git a/HACKING b/doc/HACKING
similarity index 98%
rename from HACKING
rename to doc/HACKING
index e9a159ba9f9033bdbd0afc1a5f0047e637286bd1..0682af27ba826b3be8c844eb7566755d704dcc6a 100644 (file)
--- a/HACKING
+++ b/doc/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
-CODING_STYLE for details. Also have a look at our Contribution Guidelines:
+doc/CODING_STYLE for details. Also have a look at our Contribution Guidelines:
 
         https://github.com/systemd/systemd/blob/master/.github/CONTRIBUTING.md
 

diff --git a/TRANSIENT-SETTINGS.md b/doc/TRANSIENT-SETTINGS.md
similarity index 100%
rename from TRANSIENT-SETTINGS.md
rename to doc/TRANSIENT-SETTINGS.md

diff --git a/TRANSLATORS b/doc/TRANSLATORS
similarity index 91%
rename from TRANSLATORS
rename to doc/TRANSLATORS
index 99c144eb120f006b2ee125f45645777e09fd6f7f..873ec7b01c3baae4aee3f697b35de785c5126d6d 100644 (file)
--- a/TRANSLATORS
+++ b/doc/TRANSLATORS
@@ -1,12 +1,12 @@
 Notes for translators
 =====================
 
-Systemd depends on gettext for multilingual support.
+systemd depends on gettext for multilingual support.
 In po/ directory you'll find the needed files.
 
 POT (Portable Object Template)
 ------------------------------
-A text file with .pot extension, with all the extracted labels from code. 
+A text file with .pot extension, with all the extracted labels from code.
 
 To update the template:
 

diff --git a/UIDS-GIDS.md b/doc/UIDS-GIDS.md
similarity index 100%
rename from UIDS-GIDS.md
rename to doc/UIDS-GIDS.md

diff --git a/meson.build b/meson.build
index 96340bb134d7d25dee8c7e859ba9d6731dd4a5f5..45e5cdb8ff9477d49e63493908fa1a3d57b6c96e 100644 (file)
--- a/meson.build
+++ b/meson.build
@@ -2596,15 +2596,17 @@ install_data('xorg/50-systemd-user.sh',
              install_dir : xinitrcdir)
 install_data('modprobe.d/systemd.conf',
              install_dir : modprobedir)
-install_data('README',
-             'NEWS',
-             'CODING_STYLE',
-             'DISTRO_PORTING',
-             'ENVIRONMENT.md',
-             'LICENSE.GPL2',
+install_data('LICENSE.GPL2',
              'LICENSE.LGPL2.1',
-             'TRANSIENT-SETTINGS.md',
-             'UIDS-GIDS.md',
+             'NEWS',
+             'README',
+             'doc/CODING_STYLE',
+             'doc/DISTRO_PORTING',
+             'doc/ENVIRONMENT.md',
+             'doc/HACKING',
+             'doc/TRANSIENT-SETTINGS.md',
+             'doc/TRANSLATORS',
+             'doc/UIDS-GIDS.md',
              'src/libsystemd/sd-bus/GVARIANT-SERIALIZATION',
              install_dir : docdir)
 

diff --git a/src/basic/verbs.c b/src/basic/verbs.c
index 47644670da6b5caa4ecc677f6e0a88c11c64b24e..4f3cd91465f1af8e6a8764e5a871d408da461f3e 100644 (file)
--- a/src/basic/verbs.c
+++ b/src/basic/verbs.c
@@ -41,7 +41,7 @@ bool running_in_chroot_or_offline(void) {
         /* Added to support use cases like rpm-ostree, where from %post scripts we only want to execute "preset", but
          * not "start"/"restart" for example.
          *
-         * See ENVIRONMENT.md for docs.
+         * See doc/ENVIRONMENT.md for docs.
          */
         r = getenv_bool("SYSTEMD_OFFLINE");
         if (r < 0 && r != -ENXIO)