docs: convert DISTRO_PORTING to Markdown

diff --git a/docs/DISTRO_PORTING b/docs/DISTRO_PORTING
deleted file mode 100644 (file)
index d1a187a..0000000
--- a/docs/DISTRO_PORTING
+++ /dev/null
@@ -1,71 +0,0 @@
-Porting systemd To New Distributions
-
-HOWTO:
-        You need to make the follow changes to adapt systemd to your
-        distribution:
-
-        1) Find the right configure parameters for:
-
-            -D rootprefix=
-            -D sysvinit-path=
-            -D sysvrcnd-path=
-            -D rc-local=
-            -D halt-local=
-            -D loadkeys-path=
-            -D setfont-path=
-            -D tty-gid=
-            -D ntp-servers=
-            -D dns-servers=
-            -D support-url=
-
-        2) Try it out. Play around (as an ordinary user) with
-        '/usr/lib/systemd/systemd --test --system' for a test run
-        of systemd without booting. This will read the unit files and
-        print the initial transaction it would execute during boot-up.
-        This will also inform you about ordering loops and suchlike.
-
-NTP POOL:
-        By default, systemd-timesyncd uses the Google Public NTP servers
-        time[1-4].google.com, if no other NTP configuration is available. They
-        serve time that uses a leap second smear, and can be up to .5s off from
-        servers that use stepped leap seconds.
-
-        https://developers.google.com/time/smear
-
-        If you prefer to use leap second steps, please register your own
-        vendor pool at ntp.org and make it the built-in default by
-        passing --with-ntp-servers= to configure. Registering vendor
-        pools is free:
-
-        http://www.pool.ntp.org/en/vendors.html
-
-        Use -D ntp-servers= to direct systemd-timesyncd to different fallback
-        NTP servers.
-
-DNS SERVERS:
-        By default, systemd-resolved uses the Google Public DNS servers
-        8.8.8.8, 8.8.4.4, 2001:4860:4860::8888, 2001:4860:4860::8844 as
-        fallback, if no other DNS configuration is available.
-
-        Use -D dns-servers= to direct systemd-resolved to different fallback
-        DNS servers.
-
-PAM:
-        The default PAM config shipped by systemd is really bare bones.
-        It does not include many modules your distro might want to enable
-        to provide a more seamless experience. For example, limits set in
-        /etc/security/limits.conf will not be read unless you load pam_limits.
-        Make sure you add modules your distro expects from user services.
-
-        Pass -D pamconfdir=no to meson to avoid installing this file and
-        instead install your own.
-
-CONTRIBUTING UPSTREAM:
-        We generally do no longer accept distribution-specific patches to
-        systemd upstream. If you have to make changes to systemd's source code
-        to make it work on your distribution, unless your code is generic
-        enough to be generally useful, we are unlikely to merge it. Please
-        always consider adopting the upstream defaults. If that is not
-        possible, please maintain the relevant patches downstream.
-
-        Thank you for understanding.

diff --git a/docs/DISTRO_PORTING.md b/docs/DISTRO_PORTING.md
new file mode 100644 (file)
index 0000000..bcb093f
--- /dev/null
+++ b/docs/DISTRO_PORTING.md
@@ -0,0 +1,75 @@
+# Porting systemd To New Distributions
+
+## HOWTO
+
+You need to make the follow changes to adapt systemd to your
+distribution:
+
+1. Find the right configure parameters for:
+
+   * `-Drootprefix=`
+   * `-Dsysvinit-path=`
+   * `-Dsysvrcnd-path=`
+   * `-Drc-local=`
+   * `-Dhalt-local=`
+   * `-Dloadkeys-path=`
+   * `-Dsetfont-path=`
+   * `-Dtty-gid=`
+   * `-Dntp-servers=`
+   * `-Ddns-servers=`
+   * `-Dsupport-url=`
+
+2. Try it out.
+
+   Play around (as an ordinary user) with
+   `/usr/lib/systemd/systemd --test --system` for a test run
+   of systemd without booting. This will read the unit files and
+   print the initial transaction it would execute during boot-up.
+   This will also inform you about ordering loops and suchlike.
+
+## NTP Pool
+
+By default, systemd-timesyncd uses the Google Public NTP servers
+`time[1-4].google.com`, if no other NTP configuration is available.
+They serve time that uses a
+[leap second smear](https://developers.google.com/time/smear)
+and can be up to .5s off from servers that use stepped leap seconds.
+
+If you prefer to use leap second steps, please register your own
+vendor pool at ntp.org and make it the built-in default by
+passing `-Dntp-servers=` to meson. Registering vendor
+pools is [free](http://www.pool.ntp.org/en/vendors.html).
+
+Use `-Dntp-servers=` to direct systemd-timesyncd to different fallback
+NTP servers.
+
+## DNS Servers
+
+By default, systemd-resolved uses the Google Public DNS servers
+`8.8.8.8`, `8.8.4.4`, `2001:4860:4860::8888`, `2001:4860:4860::8844`
+as fallback, if no other DNS configuration is available.
+
+Use `-Ddns-servers=` to direct systemd-resolved to different fallback
+DNS servers.
+
+## PAM
+
+The default PAM config shipped by systemd is really bare bones.
+It does not include many modules your distro might want to enable
+to provide a more seamless experience. For example, limits set in
+`/etc/security/limits.conf` will not be read unless you load `pam_limits`.
+Make sure you add modules your distro expects from user services.
+
+Pass `-Dpamconfdir=no` to meson to avoid installing this file and
+instead install your own.
+
+## Contributing Upstream
+
+We generally do no longer accept distribution-specific patches to
+systemd upstream. If you have to make changes to systemd's source code
+to make it work on your distribution, unless your code is generic
+enough to be generally useful, we are unlikely to merge it. Please
+always consider adopting the upstream defaults. If that is not
+possible, please maintain the relevant patches downstream.
+
+Thank you for understanding.

diff --git a/meson.build b/meson.build
index 2b64bcb33307f3fd6a5ba0222153903a4f9d84b3..3003eb3dc4165c458822edb8ef7b5928fda8330e 100644 (file)
--- a/meson.build
+++ b/meson.build
@@ -2767,7 +2767,7 @@ install_data('LICENSE.GPL2',
              'NEWS',
              'README',
              'docs/CODING_STYLE',
-             'docs/DISTRO_PORTING',
+             'docs/DISTRO_PORTING.md',
              'docs/ENVIRONMENT.md',
              'docs/HACKING',
              'docs/TRANSIENT-SETTINGS.md',