After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 764145 - [review] lr/gnome-developer: make developer.gnome.org/NetworkManager less unpleasant
[review] lr/gnome-developer: make developer.gnome.org/NetworkManager less unp...
Status: RESOLVED FIXED
Product: NetworkManager
Classification: Platform
Component: Documentation
git master
Other Linux
: Normal normal
: ---
Assigned To: NetworkManager maintainer(s)
NetworkManager maintainer(s)
Depends on:
Blocks: nm-review nm-1-2
 
 
Reported: 2016-03-24 13:46 UTC by Lubomir Rintel
Modified: 2016-03-29 12:44 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
programlisting --> synopsis (5.36 KB, patch)
2016-03-26 04:03 UTC, Francesco Giudici
none Details | Review

Comment 1 Thomas Haller 2016-03-24 14:09:17 UTC
>> dbus: build docbook when generating the code

ifcfg-rh-com.redhat and dispatcher interface are internal, private D-Bus APIs. Nobody is supposed to use them, except initscripts and dispatcher, respectively.

Let's not generate them.



dcbw said he likes to keep the CHANGELOG file. Me personally, I dislike it because a git-grep usually has results from the CHANGELOG in which I am not interested.




About the rest I am not familiar with this. But looks all right.
Comment 2 Beniamino Galvani 2016-03-25 09:31:32 UTC
Some command listings in the nmcli-examples output page contain HTML tags. Apart from that, looks good to me.
Comment 3 Francesco Giudici 2016-03-26 04:02:12 UTC
Seems that there are some issues with the gtkdoc conversion of netsted <example><programlisting><emphasis> tags.

In nmcli-examples.xml more recent examples take advantage of the <synopsis> tag instead of the <programlisting> one. The output in the man page should be the same... so, when dealing with sample commands, why not use always the <synopsis> tag?
Attaching s{i,a}mple patch.

Anyway, nm-docs restyling looks much better to me :-)
Comment 4 Francesco Giudici 2016-03-26 04:03:56 UTC
Created attachment 324781 [details] [review]
programlisting --> synopsis
Comment 5 Lubomir Rintel 2016-03-29 11:02:38 UTC
Merged with Beniamino's patch.
Comment 6 Beniamino Galvani 2016-03-29 12:44:17 UTC
(In reply to Lubomir Rintel from comment #5)
> Merged with Beniamino's patch.

Actually it was Francesco's one :)