mirrors/systemd
0
0
Fork 0
mirror of https://github.com/systemd/systemd.git synced 2024-11-23 10:13:34 +08:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
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.
This commit is contained in:
Lennart Poettering 2018-02-26 11:48:46 +01:00
parent 033c836647
commit f09eb7688e
12 changed files with 22 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.github/CONTRIBUTING.md vendored
View 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/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.

8
NEWS
View File

@ -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.

4
README.md
View File

@ -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).

0
CODING_STYLE → doc/CODING_STYLE
View File

0
DISTRO_PORTING → doc/DISTRO_PORTING
View File

0
ENVIRONMENT.md → doc/ENVIRONMENT.md
View File

2
HACKING → doc/HACKING
View 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
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

0
TRANSIENT-SETTINGS.md → doc/TRANSIENT-SETTINGS.md
View File

4
TRANSLATORS → doc/TRANSLATORS
View File

@ -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:

0
UIDS-GIDS.md → doc/UIDS-GIDS.md
View File

18
meson.build
View File

@ -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)

2
src/basic/verbs.c
View File

@ -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)