summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2018-02-26 11:48:46 +0100
committerLennart Poettering <lennart@poettering.net>2018-02-27 19:59:09 +0100
commitf09eb7688eeddffd6dab7f86501079f1142c860b (patch)
treefd78fdefb15dad11fc1f5c244f36ad86a18e0385
parent033c8366471ad9e0fb566399b0ea66bad63c7dd8 (diff)
downloadsystemd-f09eb7688eeddffd6dab7f86501079f1142c860b.tar.gz
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.
-rw-r--r--.github/CONTRIBUTING.md4
-rw-r--r--NEWS8
-rw-r--r--README.md4
-rw-r--r--doc/CODING_STYLE (renamed from CODING_STYLE)0
-rw-r--r--doc/DISTRO_PORTING (renamed from DISTRO_PORTING)0
-rw-r--r--doc/ENVIRONMENT.md (renamed from ENVIRONMENT.md)0
-rw-r--r--doc/HACKING (renamed from HACKING)2
-rw-r--r--doc/TRANSIENT-SETTINGS.md (renamed from TRANSIENT-SETTINGS.md)0
-rw-r--r--doc/TRANSLATORS (renamed from TRANSLATORS)4
-rw-r--r--doc/UIDS-GIDS.md (renamed from UIDS-GIDS.md)0
-rw-r--r--meson.build18
-rw-r--r--src/basic/verbs.c2
12 files changed, 22 insertions, 20 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 6f197441cb..2f266f2934 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/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 22372a8296..f5e348cc4c 100644
--- 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 06fd69142a..4b017faf1b 100644
--- 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
index ae818126cb..ae818126cb 100644
--- a/CODING_STYLE
+++ b/doc/CODING_STYLE
diff --git a/DISTRO_PORTING b/doc/DISTRO_PORTING
index d1a187aa41..d1a187aa41 100644
--- a/DISTRO_PORTING
+++ b/doc/DISTRO_PORTING
diff --git a/ENVIRONMENT.md b/doc/ENVIRONMENT.md
index 581bf3c238..581bf3c238 100644
--- a/ENVIRONMENT.md
+++ b/doc/ENVIRONMENT.md
diff --git a/HACKING b/doc/HACKING
index e9a159ba9f..0682af27ba 100644
--- 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
index ca9e8387b7..ca9e8387b7 100644
--- a/TRANSIENT-SETTINGS.md
+++ b/doc/TRANSIENT-SETTINGS.md
diff --git a/TRANSLATORS b/doc/TRANSLATORS
index 99c144eb12..873ec7b01c 100644
--- 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
index e19cc88162..e19cc88162 100644
--- a/UIDS-GIDS.md
+++ b/doc/UIDS-GIDS.md
diff --git a/meson.build b/meson.build
index 96340bb134..45e5cdb8ff 100644
--- 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 47644670da..4f3cd91465 100644
--- 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)