diff --git a/doc-migration/db2rst.py b/doc-migration/db2rst.py index 2b8bb19c27c..d1df4f3ac03 100644 --- a/doc-migration/db2rst.py +++ b/doc-migration/db2rst.py @@ -112,23 +112,23 @@ def _includes(el): el.get("xpointer")) return f".. versionadded:: {versionString}" elif not el.get("xpointer"): - return f".. include:: ./includes/{el.get('href').replace('xml', 'rst')}" + return f".. include:: ./{el.get('href').replace('xml', 'rst')}" elif el.get('href') in include_files: - return f""".. include:: ./includes/{el.get('href').replace('xml', 'rst')} + return f""".. include:: ./{el.get('href').replace('xml', 'rst')} :start-after: .. inclusion-marker-do-not-remove {el.get("xpointer")} :end-before: .. inclusion-end-marker-do-not-remove {el.get("xpointer")} """ elif file_extension == '.c': - return f""".. literalinclude:: ./includes/{el.get('href')} + return f""".. literalinclude:: ./{el.get('href')} :language: c """ elif file_extension == '.py': - return f""".. literalinclude:: ./includes/{el.get('href')} + return f""".. literalinclude:: ./{el.get('href')} :language: python """ elif file_extension == '.sh': - return f""".. literalinclude:: ./includes/{el.get('href')} + return f""".. literalinclude:: ./{el.get('href')} :language: shell """ diff --git a/doc-migration/source/busctl.rst b/doc-migration/source/busctl.rst index 61fe7e508ac..c2ad52a15f5 100644 --- a/doc-migration/source/busctl.rst +++ b/doc-migration/source/busctl.rst @@ -1,5 +1,11 @@ +..meta:: + :title: busctl + +..meta:: + :manvolnum: 1 + .. _busctl(1): ========= @@ -401,23 +407,23 @@ The following options are understood: .. versionadded:: 242 -.. include:: ./includes/user-system-options.rst +.. include:: ./user-system-options.rst :start-after: .. inclusion-marker-do-not-remove user :end-before: .. inclusion-end-marker-do-not-remove user -.. include:: ./includes/user-system-options.rst +.. include:: ./user-system-options.rst :start-after: .. inclusion-marker-do-not-remove system :end-before: .. inclusion-end-marker-do-not-remove system -.. include:: ./includes/user-system-options.rst +.. include:: ./user-system-options.rst :start-after: .. inclusion-marker-do-not-remove host :end-before: .. inclusion-end-marker-do-not-remove host -.. include:: ./includes/user-system-options.rst +.. include:: ./user-system-options.rst :start-after: .. inclusion-marker-do-not-remove machine :end-before: .. inclusion-end-marker-do-not-remove machine -.. include:: ./includes/user-system-options.rst +.. include:: ./user-system-options.rst :start-after: .. inclusion-marker-do-not-remove capsule :end-before: .. inclusion-end-marker-do-not-remove capsule @@ -428,19 +434,19 @@ The following options are understood: .. versionadded:: 245 -.. include:: ./includes/standard-options.rst +.. include:: ./standard-options.rst :start-after: .. inclusion-marker-do-not-remove no-pager :end-before: .. inclusion-end-marker-do-not-remove no-pager -.. include:: ./includes/standard-options.rst +.. include:: ./standard-options.rst :start-after: .. inclusion-marker-do-not-remove no-legend :end-before: .. inclusion-end-marker-do-not-remove no-legend -.. include:: ./includes/standard-options.rst +.. include:: ./standard-options.rst :start-after: .. inclusion-marker-do-not-remove help :end-before: .. inclusion-end-marker-do-not-remove help -.. include:: ./includes/standard-options.rst +.. include:: ./standard-options.rst :start-after: .. inclusion-marker-do-not-remove version :end-before: .. inclusion-end-marker-do-not-remove version diff --git a/doc-migration/source/includes/check-os-release-simple.py b/doc-migration/source/check-os-release-simple.py similarity index 100% rename from doc-migration/source/includes/check-os-release-simple.py rename to doc-migration/source/check-os-release-simple.py diff --git a/doc-migration/source/includes/check-os-release.py b/doc-migration/source/check-os-release.py similarity index 100% rename from doc-migration/source/includes/check-os-release.py rename to doc-migration/source/check-os-release.py diff --git a/doc-migration/source/includes/check-os-release.sh b/doc-migration/source/check-os-release.sh similarity index 100% rename from doc-migration/source/includes/check-os-release.sh rename to doc-migration/source/check-os-release.sh diff --git a/doc-migration/source/includes/common-variables.rst b/doc-migration/source/common-variables.rst similarity index 100% rename from doc-migration/source/includes/common-variables.rst rename to doc-migration/source/common-variables.rst diff --git a/doc-migration/source/journalctl.rst b/doc-migration/source/journalctl.rst index 240a15894b1..94193d6cded 100644 --- a/doc-migration/source/journalctl.rst +++ b/doc-migration/source/journalctl.rst @@ -1,5 +1,11 @@ +..meta:: + :title: journalctl + +..meta:: + :manvolnum: 1 + .. _journalctl(1): ============= @@ -181,7 +187,7 @@ The following options control where to read journal records from: .. versionadded:: 247 -.. include:: ./includes/standard-options.rst +.. include:: ./standard-options.rst :start-after: .. inclusion-marker-do-not-remove image-policy-open :end-before: .. inclusion-end-marker-do-not-remove image-policy-open @@ -681,7 +687,7 @@ Pager Control Options The following options control page support: -.. include:: ./includes/standard-options.rst +.. include:: ./standard-options.rst :start-after: .. inclusion-marker-do-not-remove no-pager :end-before: .. inclusion-end-marker-do-not-remove no-pager @@ -941,11 +947,11 @@ The following commands are understood. If none is specified the default is to di .. versionadded:: 189 -.. include:: ./includes/standard-options.rst +.. include:: ./standard-options.rst :start-after: .. inclusion-marker-do-not-remove help :end-before: .. inclusion-end-marker-do-not-remove help -.. include:: ./includes/standard-options.rst +.. include:: ./standard-options.rst :start-after: .. inclusion-marker-do-not-remove version :end-before: .. inclusion-end-marker-do-not-remove version @@ -954,9 +960,7 @@ Exit status On success, 0 is returned; otherwise, a non-zero failure code is returned. -.. include:: ./includes/common-variables.rst - :start-after: .. inclusion-marker-do-not-remove None - :end-before: .. inclusion-end-marker-do-not-remove None +.. include:: ./common-variables.rst Examples ======== diff --git a/doc-migration/source/includes/libsystemd-pkgconfig.rst b/doc-migration/source/libsystemd-pkgconfig.rst similarity index 95% rename from doc-migration/source/includes/libsystemd-pkgconfig.rst rename to doc-migration/source/libsystemd-pkgconfig.rst index 7ecc4a3f566..a042cdcebc9 100644 --- a/doc-migration/source/includes/libsystemd-pkgconfig.rst +++ b/doc-migration/source/libsystemd-pkgconfig.rst @@ -11,4 +11,3 @@ file. .. include:: ./includes/threads-aware.rst :start-after: .. inclusion-marker-do-not-remove getenv :end-before: .. inclusion-end-marker-do-not-remove getenv - diff --git a/doc-migration/source/includes/sd_journal_get_data.rst b/doc-migration/source/sd_journal_get_data.rst similarity index 88% rename from doc-migration/source/includes/sd_journal_get_data.rst rename to doc-migration/source/sd_journal_get_data.rst index 77bbdfbb8ac..e921e41f30a 100644 --- a/doc-migration/source/includes/sd_journal_get_data.rst +++ b/doc-migration/source/sd_journal_get_data.rst @@ -1,4 +1,10 @@ -:orphan: + + +..meta:: + :title: sd_journal_get_data + +..meta:: + :manvolnum: 3 .. _sd_journal_get_data(3): @@ -127,6 +133,8 @@ Errors Returned errors may indicate the following problems: +.. inclusion-marker-do-not-remove EINVAL + -EINVAL ------- @@ -134,6 +142,10 @@ Returned errors may indicate the following problems: .. versionadded:: 246 +.. inclusion-end-marker-do-not-remove EINVAL + +.. inclusion-marker-do-not-remove ECHILD + -ECHILD ------- @@ -141,6 +153,10 @@ Returned errors may indicate the following problems: .. versionadded:: 246 +.. inclusion-end-marker-do-not-remove ECHILD + +.. inclusion-marker-do-not-remove EADDRNOTAVAIL + -EADDRNOTAVAIL -------------- @@ -150,6 +166,10 @@ Returned errors may indicate the following problems: .. versionadded:: 246 +.. inclusion-end-marker-do-not-remove EADDRNOTAVAIL + +.. inclusion-marker-do-not-remove ENOENT + -ENOENT ------- @@ -157,6 +177,10 @@ Returned errors may indicate the following problems: .. versionadded:: 246 +.. inclusion-end-marker-do-not-remove ENOENT + +.. inclusion-marker-do-not-remove ENOMEM + -ENOMEM ------- @@ -164,6 +188,10 @@ Returned errors may indicate the following problems: .. versionadded:: 246 +.. inclusion-end-marker-do-not-remove ENOMEM + +.. inclusion-marker-do-not-remove ENOBUFS + -ENOBUFS -------- @@ -171,6 +199,10 @@ Returned errors may indicate the following problems: .. versionadded:: 246 +.. inclusion-end-marker-do-not-remove ENOBUFS + +.. inclusion-marker-do-not-remove E2BIG + -E2BIG ------ @@ -179,6 +211,10 @@ Returned errors may indicate the following problems: .. versionadded:: 246 +.. inclusion-end-marker-do-not-remove E2BIG + +.. inclusion-marker-do-not-remove EPROTONOSUPPORT + -EPROTONOSUPPORT ---------------- @@ -187,6 +223,10 @@ Returned errors may indicate the following problems: .. versionadded:: 246 +.. inclusion-end-marker-do-not-remove EPROTONOSUPPORT + +.. inclusion-marker-do-not-remove EBADMSG + -EBADMSG -------- @@ -194,6 +234,10 @@ Returned errors may indicate the following problems: .. versionadded:: 246 +.. inclusion-end-marker-do-not-remove EBADMSG + +.. inclusion-marker-do-not-remove EIO + -EIO ---- @@ -201,14 +245,16 @@ Returned errors may indicate the following problems: .. versionadded:: 246 +.. inclusion-end-marker-do-not-remove EIO + Notes ===== -.. include:: ./includes/threads-aware.rst +.. include:: ./threads-aware.rst :start-after: .. inclusion-marker-do-not-remove strict :end-before: .. inclusion-end-marker-do-not-remove strict -.. include:: ./includes/libsystemd-pkgconfig.rst +.. include:: ./libsystemd-pkgconfig.rst :start-after: .. inclusion-marker-do-not-remove pkgconfig-text :end-before: .. inclusion-end-marker-do-not-remove pkgconfig-text @@ -253,5 +299,3 @@ See Also ======== :ref:`systemd(1)`, :ref:`systemd.journal-fields(7)`, :ref:`sd-journal(3)`, :ref:`sd_journal_open(3)`, :ref:`sd_journal_next(3)`, :ref:`sd_journal_get_realtime_usec(3)`, :ref:`sd_journal_query_unique(3)` - - diff --git a/doc-migration/source/includes/standard-options.rst b/doc-migration/source/standard-options.rst similarity index 100% rename from doc-migration/source/includes/standard-options.rst rename to doc-migration/source/standard-options.rst diff --git a/doc-migration/source/systemd.rst b/doc-migration/source/systemd.rst index 9537e6d784d..52579ebed19 100644 --- a/doc-migration/source/systemd.rst +++ b/doc-migration/source/systemd.rst @@ -1,5 +1,11 @@ +..meta:: + :title: systemd + +..meta:: + :manvolnum: 1 + .. _systemd(1): ========== @@ -600,7 +606,7 @@ Some of the variables understood by ``systemd``: ``$SYSTEMD_LOG_LEVEL`` ---------------------- - .. include:: ./includes/common-variables.rst + .. include:: ./common-variables.rst :start-after: .. inclusion-marker-do-not-remove log-level-body :end-before: .. inclusion-end-marker-do-not-remove log-level-body @@ -609,7 +615,7 @@ Some of the variables understood by ``systemd``: ``$SYSTEMD_LOG_COLOR`` ---------------------- - .. include:: ./includes/common-variables.rst + .. include:: ./common-variables.rst :start-after: .. inclusion-marker-do-not-remove log-color-body :end-before: .. inclusion-end-marker-do-not-remove log-color-body @@ -618,7 +624,7 @@ Some of the variables understood by ``systemd``: ``$SYSTEMD_LOG_TIME`` --------------------- - .. include:: ./includes/common-variables.rst + .. include:: ./common-variables.rst :start-after: .. inclusion-marker-do-not-remove log-time-body :end-before: .. inclusion-end-marker-do-not-remove log-time-body @@ -629,7 +635,7 @@ Some of the variables understood by ``systemd``: ``$SYSTEMD_LOG_LOCATION`` ------------------------- - .. include:: ./includes/common-variables.rst + .. include:: ./common-variables.rst :start-after: .. inclusion-marker-do-not-remove log-location-body :end-before: .. inclusion-end-marker-do-not-remove log-location-body @@ -638,7 +644,7 @@ Some of the variables understood by ``systemd``: ``$SYSTEMD_LOG_TID`` -------------------- - .. include:: ./includes/common-variables.rst + .. include:: ./common-variables.rst :start-after: .. inclusion-marker-do-not-remove log-tid-body :end-before: .. inclusion-end-marker-do-not-remove log-tid-body @@ -647,7 +653,7 @@ Some of the variables understood by ``systemd``: ``$SYSTEMD_LOG_TARGET`` ----------------------- - .. include:: ./includes/common-variables.rst + .. include:: ./common-variables.rst :start-after: .. inclusion-marker-do-not-remove log-target-body :end-before: .. inclusion-end-marker-do-not-remove log-target-body @@ -656,7 +662,7 @@ Some of the variables understood by ``systemd``: ``$SYSTEMD_LOG_RATELIMIT_KMSG`` ------------------------------- - .. include:: ./includes/common-variables.rst + .. include:: ./common-variables.rst :start-after: .. inclusion-marker-do-not-remove log-ratelimit-kmsg-body :end-before: .. inclusion-end-marker-do-not-remove log-ratelimit-kmsg-body @@ -682,27 +688,27 @@ Some of the variables understood by ``systemd``: usual set of paths. Otherwise, the specified list replaces the usual set of paths. -.. include:: ./includes/common-variables.rst +.. include:: ./common-variables.rst :start-after: .. inclusion-marker-do-not-remove pager :end-before: .. inclusion-end-marker-do-not-remove pager -.. include:: ./includes/common-variables.rst +.. include:: ./common-variables.rst :start-after: .. inclusion-marker-do-not-remove less :end-before: .. inclusion-end-marker-do-not-remove less -.. include:: ./includes/common-variables.rst +.. include:: ./common-variables.rst :start-after: .. inclusion-marker-do-not-remove lesscharset :end-before: .. inclusion-end-marker-do-not-remove lesscharset -.. include:: ./includes/common-variables.rst +.. include:: ./common-variables.rst :start-after: .. inclusion-marker-do-not-remove lesssecure :end-before: .. inclusion-end-marker-do-not-remove lesssecure -.. include:: ./includes/common-variables.rst +.. include:: ./common-variables.rst :start-after: .. inclusion-marker-do-not-remove colors :end-before: .. inclusion-end-marker-do-not-remove colors -.. include:: ./includes/common-variables.rst +.. include:: ./common-variables.rst :start-after: .. inclusion-marker-do-not-remove urlify :end-before: .. inclusion-end-marker-do-not-remove urlify @@ -1209,11 +1215,11 @@ be invoked with them at any time: or not. Note that it is not supported booting and maintaining a system with the service manager running in ``--system`` mode but with a PID other than 1. -.. include:: ./includes/standard-options.rst +.. include:: ./standard-options.rst :start-after: .. inclusion-marker-do-not-remove help :end-before: .. inclusion-end-marker-do-not-remove help -.. include:: ./includes/standard-options.rst +.. include:: ./standard-options.rst :start-after: .. inclusion-marker-do-not-remove version :end-before: .. inclusion-end-marker-do-not-remove version @@ -1420,7 +1426,7 @@ Files :ref:`systemd-timesyncd.service(8)`. If present, the modification time of file is used for the epoch, see previous section. - .. versionadded:: None + .. versionadded:: 257 History ======= diff --git a/doc-migration/source/includes/threads-aware.rst b/doc-migration/source/threads-aware.rst similarity index 99% rename from doc-migration/source/includes/threads-aware.rst rename to doc-migration/source/threads-aware.rst index 6c904c54b4a..e338ab8c37a 100644 --- a/doc-migration/source/includes/threads-aware.rst +++ b/doc-migration/source/threads-aware.rst @@ -14,5 +14,3 @@ here must not call `setenv(3) `_ from a parallel thread. It is recommended to only do calls to ``setenv()`` from an early phase of the program when no other threads have been started. - - diff --git a/doc-migration/source/includes/user-system-options.rst b/doc-migration/source/user-system-options.rst similarity index 100% rename from doc-migration/source/includes/user-system-options.rst rename to doc-migration/source/user-system-options.rst