colin/NetworkManager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
30,959 Commits 4 Branches 0 Tags
6ce2aae011e2071b0cd4d4e8f6f99b0126abc360
Commit Graph

11 Commits

Author SHA1 Message Date
Lubomir Rintel
6ce2aae011 generate-docs-nm-settings-docs-merge: streamline a bit 
Replace a pair of overly sophisticated expressions with something that's
easier to follow, avoiding code duplication at the same time.
 2022-09-07 10:55:31 +02:00
Vojtech Bubela
5e4632f021 doc: preserve paraghraphs in nmcli man pages 
Improve documentation by preserving paragraphs in the
nm-settings-nmcli man pages.

To do that structure of src/libnm-client-impl/nm-settings-docs-gir.xml
was changed to have "description" as subnode to property node instead
of attribute of property node. Another subnode "description-docbook"
was added - this node is then used when generating man pages.

tools/generate-docs-nm-settings-docs-gir.py and man/nm-settings-dbus.xsl
were also changed to accomodate for changes mentioned above.

Replace xsltproc tool with python script when generating
./src/libnmc-setting/settings-docs.h.

Deleted settings-docs.xsl since it was replaced by python script.

Change src/libnmc-setting/settings-docs.h.in accodring to newly
generated src/libnmc-setting/settings-docs.h

https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/issues/661

https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/merge_requests/1260
 2022-07-15 17:25:15 +02:00
Wen Liang
0b87d8d6c5 Support new attribute tag description-docbook 
`description-docbook` is the alternative tag to `description`, the
difference is that `description-docbook` expects docbook XML but not
plaintext.

Signed-off-by: Wen Liang <liangwen12year@gmail.com>
 2021-06-23 08:59:45 -04:00
Thomas Haller
85c6ab97ef tools: add debug printf statements to "tools/generate-docs-nm-settings-docs-merge.py" 
It's hard to understand what "tools/generate-docs-nm-settings-docs-merge.py"
does. Add dbg() statements that are all NOP by default. But the user can
easily patch the code to print what is happening. This is only for
debugging the script.
 2021-06-09 12:46:32 +02:00
Thomas Haller
26f0fb0604 python: remove unused imports 
They are flagged by lgtm.com. Avoid the warning by dropping unused
includes.
 2021-05-27 08:52:30 +02:00
Thomas Haller
977ea352a0 all: update deprecated SPDX license identifiers 
These SPDX license identifiers are deprecated ([1]). Update them.

[1] https://spdx.org/licenses/

  sed \
     -e '1 s%^/\* SPDX-License-Identifier: \(GPL-2.0\|LGPL-2.1\)+ \*/$%/* SPDX-License-Identifier: \1-or-later */%' \
     -e '1,2 s%^\(--\|#\|//\) SPDX-License-Identifier: \(GPL-2.0\|LGPL-2.1\)+$%\1 SPDX-License-Identifier: \2-or-later%' \
     -i \
     $(git grep -l SPDX-License-Identifier -- \
         ':(exclude)shared/c-*/' \
         ':(exclude)shared/n-*/' \
         ':(exclude)shared/systemd/src' \
         ':(exclude)src/systemd/src')
 2021-01-05 09:46:21 +01:00
Sayed Shah
be822b52e6 all: reformat python files with python black 
Part of !537.

https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/merge_requests/537
 2020-06-15 16:40:38 +02:00
Thomas Haller
125cbf5737 docs: show aliases for settings in man nm-settings-nmcli 2020-06-12 14:01:26 +02:00
Thomas Haller
a3b9b661d4 docs: add "Alias" column to man nm-settings-nmcli 2020-06-12 12:09:30 +02:00
Thomas Haller
3c11116c48 docs: in "generate-docs-nm-settings-docs-merge.py" only take properties from first setting 
Especially for "nm-settings-docs-nmcli.xml", the first XML to merge is
"clients/cli/generate-docs-nm-settings-nmcli.xml". That file is
generated with the meta data from nmcli, and it contains all the
properties that are supported. Properties from other XML files,
that are passed as additional arguments should not be merged.

In most cases, there is no difference. It only matters for
"ipv6.dad-timeout" and "user.data". For example, "ipv6.dad-timeout"
is supported by GObject (part of "libnm/nm-settings-docs-gir.xml"),
but not by nmcli. Don't include it in the manual.

This also drops the now empty settings "dummy", "user", and "generic".
 2020-06-12 10:26:27 +02:00
Thomas Haller
87edf2f298 docs: move generate-docs scripts from "libnm/" to "tools/" 
They are not only used in "libnm/" directory. Move to "tools/".
 2020-06-11 10:53:50 +02:00