Bug#1080966: gdbus-codegen.1: Some remarks about this man page
Bjarni Ingi Gislason
bjarniig at simnet.is
Fri Sep 6 01:02:39 BST 2024
Package: libglib2.0-dev-bin
Version: 2.82.0-1
Severity: minor
* What led up to the situation?
Checking for defects with
[test-]groff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z < "man page"
[test-groff is a script in the repository for "groff"] (local copy and
"troff" slightly changed by me).
* What was the outcome of this action?
troff: backtrace: file '<stdin>':797
troff:<stdin>:797: warning: [page 9, 8.4i (diversion '3tbd2,2', 0.7i)]: cannot break line
troff: backtrace: file '<stdin>':998
troff:<stdin>:998: warning: trailing space in the line
* What outcome did you expect instead?
No output (no warnings).
-.-
General remarks and further material, if a diff-file exist, are in the
attachments.
-- System Information:
Debian Release: trixie/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.10.6-amd64 (SMP w/2 CPU threads; PREEMPT)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1), LANGUAGE not set
Shell: /bin/sh linked to /usr/bin/dash
Init: sysvinit (via /sbin/init)
Versions of packages libglib2.0-dev-bin depends on:
ii libc6 2.40-2
ii libglib2.0-0t64 2.82.0-1
ii python3 3.12.5-1
ii python3-packaging 24.1-1
libglib2.0-dev-bin recommends no packages.
Versions of packages libglib2.0-dev-bin suggests:
pn libgdk-pixbuf2.0-bin <none>
pn libxml2-utils <none>
-- no debconf information
-------------- next part --------------
Any program (person), that produces man pages, should check its content for
defects by using
groff -mandoc -t -ww -b -z [ -K utf8 | k ] <man page>
The same goes for man pages that are used as an input.
For a style guide use
mandoc -T lint
-.-
So any 'generator' should check its products with the above mentioned
'groff', 'mandoc', and additionally with 'nroff ...'.
This is just a simple quality control measure.
The 'generator' may have to be corrected to get a better man page,
the source file may, and any additional file may.
Common defects:
Input text line longer than 80 bytes.
Not removing trailing spaces (in in- and output).
The reason for these trailing spaces should be found and eliminated.
Not beginning each input sentence on a new line.
Lines should thus be shorter.
See man-pages(7), item 'semantic newline'.
-.-
The difference between the formatted outputs can be seen with:
nroff -mandoc <file1> > <out1>
nroff -mandoc <file2> > <out2>
diff -u <out1> <out2>
and for groff, using
"printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -mandoc -Z - "
instead of \'nroff -mandoc\'
Add the option \'-t\', if the file contains a table.
Read the output of \'diff -u\' with \'less -R\' or similar.
-.-.
If \'man\' (man-db) is used to check the manual for warnings,
the following must be set:
The option "-warnings=w"
The environmental variable:
export MAN_KEEP_STDERR=yes (or any non-empty value)
or
(produce only warnings):
export MANROFFOPT="-ww -b -z"
export MAN_KEEP_STDERR=yes (or any non-empty value)
-.-.
Output from "mandoc -T lint gdbus-codegen.1": (possibly shortened list)
mandoc: gdbus-codegen.1:31:24: WARNING: missing date, using "": TH
mandoc: gdbus-codegen.1:68:2: WARNING: skipping paragraph macro: sp after SH
mandoc: gdbus-codegen.1:73:104: STYLE: input text line longer than 80 bytes: D\-Bus Introspection...
mandoc: gdbus-codegen.1:76:84: STYLE: input text line longer than 80 bytes: output files. It cur...
mandoc: gdbus-codegen.1:82:2: WARNING: skipping paragraph macro: sp after SH
mandoc: gdbus-codegen.1:92:88: STYLE: input text line longer than 80 bytes: For C code generatio...
mandoc: gdbus-codegen.1:94:86: STYLE: input text line longer than 80 bytes: information source c...
mandoc: gdbus-codegen.1:98:86: STYLE: input text line longer than 80 bytes: Both files can be ge...
mandoc: gdbus-codegen.1:99:82: STYLE: input text line longer than 80 bytes: this option is depre...
mandoc: gdbus-codegen.1:100:85: STYLE: input text line longer than 80 bytes: generation of multip...
mandoc: gdbus-codegen.1:105:81: STYLE: input text line longer than 80 bytes: stripped with the pr...
mandoc: gdbus-codegen.1:107:86: STYLE: input text line longer than 80 bytes: interface \fBcom.acm...
mandoc: gdbus-codegen.1:108:83: STYLE: input text line longer than 80 bytes: interface \fBorg.pro...
mandoc: gdbus-codegen.1:114:88: STYLE: input text line longer than 80 bytes: Two forms of the nam...
mandoc: gdbus-codegen.1:115:82: STYLE: input text line longer than 80 bytes: CamelCase form is us...
mandoc: gdbus-codegen.1:127:83: STYLE: input text line longer than 80 bytes: is \fBiscsi_target\f...
mandoc: gdbus-codegen.1:128:84: STYLE: input text line longer than 80 bytes: with the value \fBEj...
mandoc: gdbus-codegen.1:130:2: WARNING: skipping paragraph macro: sp after SH
mandoc: gdbus-codegen.1:136:2: WARNING: skipping paragraph macro: sp after SH
mandoc: gdbus-codegen.1:143:2: WARNING: skipping paragraph macro: sp after SH
mandoc: gdbus-codegen.1:178:81: STYLE: input text line longer than 80 bytes: Pass \fB\-\-output\-...
mandoc: gdbus-codegen.1:190:81: STYLE: input text line longer than 80 bytes: Pass \fB\-\-output\-...
mandoc: gdbus-codegen.1:200:82: STYLE: input text line longer than 80 bytes: output in a differen...
mandoc: gdbus-codegen.1:268:93: STYLE: input text line longer than 80 bytes: Using \fB\-\-generat...
mandoc: gdbus-codegen.1:269:82: STYLE: input text line longer than 80 bytes: are not allowed to b...
mandoc: gdbus-codegen.1:280:93: STYLE: input text line longer than 80 bytes: Using \fB\-\-generat...
mandoc: gdbus-codegen.1:281:82: STYLE: input text line longer than 80 bytes: are not allowed to b...
mandoc: gdbus-codegen.1:293:93: STYLE: input text line longer than 80 bytes: Using \fB\-\-generat...
mandoc: gdbus-codegen.1:307:93: STYLE: input text line longer than 80 bytes: Using \fB\-\-generat...
mandoc: gdbus-codegen.1:318:82: STYLE: input text line longer than 80 bytes: prototypes in the ge...
mandoc: gdbus-codegen.1:331:82: STYLE: input text line longer than 80 bytes: guards or \fB#pragma...
mandoc: gdbus-codegen.1:346:81: STYLE: input text line longer than 80 bytes: macro is needed to e...
mandoc: gdbus-codegen.1:358:87: STYLE: input text line longer than 80 bytes: The full path where ...
mandoc: gdbus-codegen.1:359:88: STYLE: input text line longer than 80 bytes: the source code (\fB...
mandoc: gdbus-codegen.1:363:93: STYLE: input text line longer than 80 bytes: Using \fB\-\-generat...
mandoc: gdbus-codegen.1:364:82: STYLE: input text line longer than 80 bytes: is not allowed along...
mandoc: gdbus-codegen.1:370:83: STYLE: input text line longer than 80 bytes: For \fB\-\-body\fP a...
mandoc: gdbus-codegen.1:374:85: STYLE: input text line longer than 80 bytes: filename like \fBfoo...
mandoc: gdbus-codegen.1:422:82: STYLE: input text line longer than 80 bytes: backwards\-incompati...
mandoc: gdbus-codegen.1:434:82: STYLE: input text line longer than 80 bytes: are integers. \fBMIN...
mandoc: gdbus-codegen.1:461:82: STYLE: input text line longer than 80 bytes: are integers. \fBMIN...
mandoc: gdbus-codegen.1:467:2: WARNING: skipping paragraph macro: sp after SH
mandoc: gdbus-codegen.1:476:100: STYLE: input text line longer than 80 bytes: D\-Bus specification...
mandoc: gdbus-codegen.1:499:88: STYLE: input text line longer than 80 bytes: function pointer ord...
mandoc: gdbus-codegen.1:510:82: STYLE: input text line longer than 80 bytes: be used on \fB<inter...
mandoc: gdbus-codegen.1:554:82: STYLE: input text line longer than 80 bytes: note that parser use...
mandoc: gdbus-codegen.1:603:81: STYLE: input text line longer than 80 bytes: interfaces, methods,...
mandoc: gdbus-codegen.1:618:2: WARNING: skipping paragraph macro: sp after SH
mandoc: gdbus-codegen.1:658:83: STYLE: input text line longer than 80 bytes: abstract \fBGTypeInt...
mandoc: gdbus-codegen.1:767:81: STYLE: input text line longer than 80 bytes: method, one \fBGObje...
mandoc: gdbus-codegen.1:768:90: STYLE: input text line longer than 80 bytes: for completing an in...
mandoc: gdbus-codegen.1:825:2: WARNING: skipping paragraph macro: sp after SS
mandoc: gdbus-codegen.1:858:82: STYLE: input text line longer than 80 bytes: Note that all proper...
mandoc: gdbus-codegen.1:861:104: STYLE: input text line longer than 80 bytes: (documentation <http...
mandoc: gdbus-codegen.1:864:82: STYLE: input text line longer than 80 bytes: setting a property w...
mandoc: gdbus-codegen.1:867:2: WARNING: skipping paragraph macro: sp after SS
mandoc: gdbus-codegen.1:868:81: STYLE: input text line longer than 80 bytes: The generated \fBMyA...
mandoc: gdbus-codegen.1:939:81: STYLE: input text line longer than 80 bytes: an idle handler (whi...
mandoc: gdbus-codegen.1:942:104: STYLE: input text line longer than 80 bytes: (documentation <http...
mandoc: gdbus-codegen.1:949:2: WARNING: skipping paragraph macro: sp after SH
mandoc: gdbus-codegen.1:950:89: STYLE: input text line longer than 80 bytes: Scalar types (type s...
mandoc: gdbus-codegen.1:952:83: STYLE: input text line longer than 80 bytes: arrays of strings (t...
mandoc: gdbus-codegen.1:953:90: STYLE: input text line longer than 80 bytes: natural types, e.g. ...
mandoc: gdbus-codegen.1:962:2: WARNING: skipping paragraph macro: sp after SH
mandoc: gdbus-codegen.1:985:85: STYLE: input text line longer than 80 bytes: While the generated ...
mandoc: gdbus-codegen.1:992:2: WARNING: skipping paragraph macro: sp after SH
mandoc: gdbus-codegen.1:997:2: WARNING: skipping paragraph macro: sp after SH
mandoc: gdbus-codegen.1:998:12: STYLE: whitespace at end of input line
-.-.
Remove space characters at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
998: <gdbus(1)>
-.-.
Remove space in the first column, if not indented.
Use ".in +<number>n" and ".in" to end it; ".nf" and ".fi" to end
it, for an extra indention.
gdbus-codegen.1:140: document
gdbus-codegen.1:213: or \fIUgly_Case\fP (see
gdbus-codegen.1:223: preprocessor
gdbus-codegen.1:530: or \fIUgly_Case\fP (see
gdbus-codegen.1:611: and
gdbus-codegen.1:613: respectively.
gdbus-codegen.1:979: and
gdbus-codegen.1:981: comments and
gdbus-codegen.1:998: <gdbus(1)>
-.-.
Strings longer than 3/4 of a standard line length (80).
Use '\:' to split the string at the end of an output line, for example long
URLs (web address)
73 D\-Bus Introspection XML <https://dbus.freedesktop.org/doc/dbus-specification.html#introspection-format>
476 D\-Bus specification <https://dbus.freedesktop.org/doc/dbus-specification.html#introspection-format>
861 (documentation <https://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-properties>
942 (documentation <https://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-properties>
-.-.
Add a comma (or \&) after "e.g." and "i.e.", or use English words
(man-pages(7)).
Abbreviation points should be protected against being interpreted as
an end of sentence, if they are not, and that independent of the
current place on the line.
176:name, e.g. \fBnet.Corp.FooBar\fP and so on.
188:name, e.g. \fBnet.Corp.FooBar\fP and so on.
602:Note that \fB at since\fP can be used in any inline documentation bit (e.g. for
873:\fBGObject\fP property from the subclass. To emit a signal, use e.g.
953:natural types, e.g. \fBgboolean\fP, \fBgdouble\fP, \fBgint\fP, \fBgchar*\fP, \fBgchar**\fP
983:about e.g. \fBSECTION\fP usage etc. are given.
-.-.
Wrong distance between sentences in the input file.
Separate the sentences and subordinate clauses; each begins on a new
line. See man-pages(7) ("Conventions for source file layout") and
"info groff" ("Input Conventions").
The best procedure is to always start a new sentence on a new line,
at least, if you are typing on a computer.
Remember coding: Only one command ("sentence") on each (logical) line.
E-mail: Easier to quote exactly the relevant lines.
Generally: Easier to edit the sentence.
Patches: Less unaffected text.
Search for two adjacent words is easier, when they belong to the same line,
and the same phrase.
The number of lines affected can be too large to be in the patch.
76:output files. It currently supports generating C source code (via \fB\-\-body\fP) or
84:D\-Bus interface. Additionally, for every generated type, \fBFooBar\fP, two
86:implementing said interface are also generated. The former is derived from
95:information headers, can be used. These options must be used along with
99:this option is deprecated. In this case \fB\-\-output\fP cannot be used due to the
100:generation of multiple files. Instead pass \fB\-\-output\-directory\fP to specify the
101:directory to put the output files in. By default the current directory will be
106:removed and initial characters capitalized. For example, for the D\-Bus
107:interface \fBcom.acme.Coyote\fP the name used is \fBComAcmeCoyote\fP\&. For the D\-Bus
114:Two forms of the name are used ??? the CamelCase form and the lower\-case form. The
116:is used in function names. The lower\-case form is calculated by converting from
123:lower\-case name is derived by lower\-casing the string. This is useful in some
124:situations where abbreviations are used. For example, if the annotation is used
127:is \fBiscsi_target\fP\&. If the annotation is used on the method \fBEjectTheiPod\fP
132:details) is a \fBRefEntry\fP article describing the D\-Bus interface. (See the
176:name, e.g. \fBnet.Corp.FooBar\fP and so on.
179:in. By default the current directory will be used.
188:name, e.g. \fBnet.Corp.FooBar\fP and so on.
191:in. By default the current directory will be used.
199:\fBOUTFILES.h\fP including any sub\-directories. If you want the files to be
211:The namespace to use for generated C code. This is expected to be in
241:generated for. \fBnone\fP means to not generate any autocleanup functions.
243:generate them for object types and interfaces. The default is \fBobjects\fP
253:Directory to output generated source to. Equivalent to changing directory
318:prototypes in the generated header will be marked with \fBDECORATOR\fP\&. This can
360:the path and filename provided by \fB\-\-output\fP\&. The full path could be
388:Used to inject D\-Bus annotations into the given XML files. It can be used with
421:\fBgdbus\-codegen\fP can depend on. This may be used to make
424:\fB\-\-glib\-min\-required\fP\&. If this option is not passed, the output from
434:are integers. \fBMINOR\fP and \fBMICRO\fP are optional. The version number may not
456:\fBgdbus\-codegen\fP can depend on. This may be used to ensure that code
461:are integers. \fBMINOR\fP and \fBMICRO\fP are optional. The version number must be
475:is \fBtrue\fP\&. Note that this annotation is defined in the
478:and can only assume the values \fBtrue\fP and \fBfalse\fP\&. In particular, you
480:deprecation message. Such information should be added to the element
509:A string with DocBook content for documentation. This annotation can
518:A string with DocBook content for short/brief documentation. This annotation
527:\fB<property>\fP element to specify the name to use when generating C code. The
539:the natural C type. This annotation can be used on any \fB<arg>\fP and
548:exchange file descriptors using the \fBGUnixFDList\fP type. This annotation can
595: <!\-\- BazProperty: The docs for the property. \-\->
602:Note that \fB at since\fP can be used in any inline documentation bit (e.g. for
604:annotation. For the \fBorg.gtk.GDBus.DocString\fP annotation (and inline
608:interface, method, signal and property. Additionally, substrings starting with
651: \-\-interface\-prefix net.corp.MyApp. \e
657:two files called \fBmyapp\-generated.[ch]\fP are generated. The files provide an
660:\fBSkeleton\fP\&. The generated file, roughly, contains the following facilities:
701:/* Synchronously calls HelloWorld(). Blocks calling thread. */
768:for completing an incoming call. For every D\-Bus signal, there???s one \fBGObject\fP
769:signal and one C function for emitting it. For every D\-Bus property, two C
797:Receive via the \fBhandle_hello_world()\fP signal handler. Complete the call with \fBm_a_f_complete_hello_world()\fP\&.
855:\fBmy_app_set_verbose()\fP methods. Use the standard \fBGObject::notify\fP signal to
859:is ever done when reading properties. Also note that setting a property will
863:to be called on the remote object. This call, however, is asynchronous so
864:setting a property won???t block. Further, the change is delayed and no error
869:it in a \fBGObject\fP subclass. For example, to handle \fBHelloWorld()\fP method
871:\fBMyAppFrobberIface\fP structure. Similarly, to handle the
873:\fBGObject\fP property from the subclass. To emit a signal, use e.g.
877:\fBMyAppFrobberSkeleton\fP subclass. To handle incoming method calls, use
898: response = g_strdup_printf (\(dqWord! You said ???%s???.\(dq, greeting);
938:\fBGObject::notify\fP signals are queued up when received. The queue is drained in
944:signal with all the properties that have changed. Use
946:empty the queue immediately. Use \fBg_object_freeze_notify()\fP and
953:natural types, e.g. \fBgboolean\fP, \fBgdouble\fP, \fBgint\fP, \fBgchar*\fP, \fBgchar**\fP
954:and so on. Everything else is mapped to the \fBGVariant\fP type.
958:exchanged instead of the corresponding native C type. This annotation may be
963:The generated C functions are guaranteed to not change their ABI. That is, if a
965:XML, the generated C functions will not change their C ABI either. The ABI of
982:annotations. The layout and contents might change in the future so no guarantees
983:about e.g. \fBSECTION\fP usage etc. are given.
-.-.
Split lines longer than 80 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
Line 50, length 120
[\-\-header | \-\-body | \-\-interface\-info\-header | \-\-interface\-info\-body | \-\-generate\-c\-code \fIOUTFILES\fP]
Line 59, length 129
[\-\-symbol\-decorator \fIDECORATOR\fP [\-\-symbol\-decorator\-header \fIHEADER\fP] [\-\-symbol\-decorator\-define \fIDEFINE\fP]]
Line 69, length 82
\fBgdbus\-codegen\fP is used to generate code and/or documentation for one or more
Line 73, length 104
D\-Bus Introspection XML <https://dbus.freedesktop.org/doc/dbus-specification.html#introspection-format>
Line 76, length 84
output files. It currently supports generating C source code (via \fB\-\-body\fP) or
Line 92, length 88
For C code generation either \fB\-\-body\fP that generates source code, \fB\-\-header\fP
Line 94, length 86
information source code, or \fB\-\-interface\-info\-header\fP that generates interface
Line 98, length 86
Both files can be generated at the same time by using \fB\-\-generate\-c\-code\fP, but
Line 99, length 82
this option is deprecated. In this case \fB\-\-output\fP cannot be used due to the
Line 100, length 85
generation of multiple files. Instead pass \fB\-\-output\-directory\fP to specify the
Line 105, length 81
stripped with the prefix given with \fB\-\-interface\-prefix\fP and with the dots
Line 107, length 86
interface \fBcom.acme.Coyote\fP the name used is \fBComAcmeCoyote\fP\&. For the D\-Bus
Line 108, length 83
interface \fBorg.project.Bar.Frobnicator\fP with \fB\-\-interface\-prefix\fP set to
Line 114, length 83
Two forms of the name are used ??? the CamelCase form and the lower\-case form. The
Line 115, length 82
CamelCase form is used for the \fBGType\fP and struct name, while lower\-case form
Line 121, length 88
\fB\-\-c\-namespace\fP option contains an underscore (sometimes called \fIUgly_Case\fP),
Line 126, length 85
\fBiSCSI_Target\fP the CamelCase form is \fBiSCSITarget\fP while the lower\-case form
Line 127, length 83
is \fBiscsi_target\fP\&. If the annotation is used on the method \fBEjectTheiPod\fP
Line 128, length 84
with the value \fBEject_The_iPod\fP, the lower\-case form is \fBeject_the_ipod\fP\&.
Line 178, length 81
Pass \fB\-\-output\-directory\fP to specify the directory to put the output files
Line 190, length 81
Pass \fB\-\-output\-directory\fP to specify the directory to put the output files
Line 200, length 82
output in a different location use \fB\-\-output\-directory\fP as \fBOUTFILES.h\fP
Line 257, length 90
\fB\-\-interface\-info\-body\fP or \fB\-\-interface\-info\-header\fP; and \fB\-\-output\fP
Line 268, length 93
Using \fB\-\-generate\-c\-code\fP, \fB\-\-generate\-docbook\fP or \fB\-\-output\-directory\fP
Line 269, length 82
are not allowed to be used along with \fB\-\-header\fP and \fB\-\-body\fP options,
Line 280, length 93
Using \fB\-\-generate\-c\-code\fP, \fB\-\-generate\-docbook\fP or \fB\-\-output\-directory\fP
Line 281, length 82
are not allowed to be used along with \fB\-\-header\fP and \fB\-\-body\fP options,
Line 293, length 93
Using \fB\-\-generate\-c\-code\fP, \fB\-\-generate\-docbook\fP or \fB\-\-output\-directory\fP
Line 295, length 83
\fB\-\-interface\-info\-body\fP options, because these options are used to generate
Line 307, length 93
Using \fB\-\-generate\-c\-code\fP, \fB\-\-generate\-docbook\fP or \fB\-\-output\-directory\fP
Line 309, length 83
\fB\-\-interface\-info\-body\fP options, because these options are used to generate
Line 318, length 82
prototypes in the generated header will be marked with \fBDECORATOR\fP\&. This can
Line 331, length 82
guards or \fB#pragma once\fP (if \fB\-\-pragma\-once\fP is used). This is used if
Line 346, length 81
macro is needed to ensure the decorator passed in via \fB\-\-symbol\-decorator\fP
Line 358, length 87
The full path where the header (\fB\-\-header\fP, \fB\-\-interface\-info\-header\fP) or
Line 359, length 88
the source code (\fB\-\-body\fP, \fB\-\-interface\-info\-body\fP) will be written, using
Line 363, length 93
Using \fB\-\-generate\-c\-code\fP, \fB\-\-generate\-docbook\fP or \fB\-\-output\-directory\fP
Line 364, length 82
is not allowed along with \fB\-\-output\fP, because the latter is used to generate
Line 370, length 83
For \fB\-\-body\fP and \fB\-\-interface\-info\-body\fP, the generated code will not
Line 374, length 85
filename like \fBfoo\-impl.h\fP and \fB#include\fP it into a wrapper \fB\&.c\fP file.
Line 422, length 82
backwards\-incompatible changes in the output or behaviour of \fBgdbus\-codegen\fP
Line 434, length 82
are integers. \fBMINOR\fP and \fBMICRO\fP are optional. The version number may not
Line 461, length 82
are integers. \fBMINOR\fP and \fBMICRO\fP are optional. The version number must be
Line 476, length 100
D\-Bus specification <https://dbus.freedesktop.org/doc/dbus-specification.html#introspection-format>
Line 510, length 82
be used on \fB<interface>\fP, \fB<method>\fP, \fB<signal>\fP, \fB<property>\fP and
Line 554, length 82
note that parser used by \fBgdbus\-codegen\fP parses XML comments in a way similar
Line 603, length 81
interfaces, methods, signals and properties) to set the \fBorg.gtk.GDBus.Since\fP
Line 607, length 82
\fB#net.Corp.InlineDocs:BazProperty\fP are all expanded to links to the respective
Line 658, length 83
abstract \fBGTypeInterface\fP derived type called \fBMyAppFrobber\fP as well as two
Line 660, length 81
\fBSkeleton\fP\&. The generated file, roughly, contains the following facilities:
Line 767, length 81
method, one \fBGObject\fP signal for handling an incoming call and one C function
Line 768, length 85
for completing an incoming call. For every D\-Bus signal, there???s one \fBGObject\fP
Line 797, length 119
Receive via the \fBhandle_hello_world()\fP signal handler. Complete the call with \fBm_a_f_complete_hello_world()\fP\&.
Line 853, length 83
\fBnet.Corp.MyApp.Frobber:Verbose\fP D\-Bus Property using either the \fBGObject\fP
Line 855, length 84
\fBmy_app_set_verbose()\fP methods. Use the standard \fBGObject::notify\fP signal to
Line 858, length 82
Note that all property access is via the \fBGDBusProxy\fP property cache so no I/O
Line 861, length 104
(documentation <https://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-properties>
Line 868, length 81
The generated \fBMyAppFrobber\fP interface is designed so it is easy to implement
Line 880, length 81
\fBGObject\fP, use \fBg_object_get()\fP and \fBg_object_set()\fP or the generated
Line 938, length 82
\fBGObject::notify\fP signals are queued up when received. The queue is drained in
Line 939, length 81
an idle handler (which is called from the thread\-default main loop of the thread
Line 942, length 104
(documentation <https://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-properties>
Line 945, length 82
\fBg_dbus_interface_skeleton_flush()\fP or \fBg_dbus_object_skeleton_flush()\fP to
Line 950, length 89
Scalar types (type strings \fBb\fP, \fBy\fP, \fBn\fP, \fBq\fP, \fBi\fP, \fBu\fP, \fBx\fP,
Line 951, length 87
\fBt\fP and \fBd\fP), strings (type strings \fBs\fP, \fBay\fP, \fBo\fP and \fBg\fP) and
Line 952, length 83
arrays of strings (type strings \fBas\fP, \fBao\fP and \fBaay\fP) are mapped to the
Line 953, length 90
natural types, e.g. \fBgboolean\fP, \fBgdouble\fP, \fBgint\fP, \fBgchar*\fP, \fBgchar**\fP
Line 974, length 81
\fBorg.gtk.GDBus.Since\fP annotation using a greater version number than previous
-.-.
Show if docman-to-man created this
55:[\-\-generate\-docbook \fIOUTFILES\fP]
77:header (via \fB\-\-header\fP) and DocBook XML (via \fB\-\-generate\-docbook\fP).
129:.SH GENERATING DOCBOOK DOCUMENTATION
131:Each generated DocBook XML file (see the \fB\-\-generate\-docbook\fP option for
133:DocBook documentation <https://tdg.docbook.org/tdg/4.5/refentry.html>
165:calculating the type name for the C binding and the DocBook \fBsortas\fP
166:attribute <https://tdg.docbook.org/tdg/4.5/primary.html>
171:\fB\-\-generate\-docbook\fP \fIOUTFILES\fP
174:Generate DocBook Documentation for each D\-Bus interface and put it in
268:Using \fB\-\-generate\-c\-code\fP, \fB\-\-generate\-docbook\fP or \fB\-\-output\-directory\fP
280:Using \fB\-\-generate\-c\-code\fP, \fB\-\-generate\-docbook\fP or \fB\-\-output\-directory\fP
293:Using \fB\-\-generate\-c\-code\fP, \fB\-\-generate\-docbook\fP or \fB\-\-output\-directory\fP
307:Using \fB\-\-generate\-c\-code\fP, \fB\-\-generate\-docbook\fP or \fB\-\-output\-directory\fP
363:Using \fB\-\-generate\-c\-code\fP, \fB\-\-generate\-docbook\fP or \fB\-\-output\-directory\fP
486:When generating DocBook XML, a deprecation warning will appear along the
501:When generating DocBook XML, the value of this tag appears in the
509:A string with DocBook content for documentation. This annotation can
518:A string with DocBook content for short/brief documentation. This annotation
610:parameter <https://tdg.docbook.org/tdg/4.5/parameter.html>
612:constant <https://tdg.docbook.org/tdg/4.5/constant.html>
985:While the generated DocBook for D\-Bus interfaces isn???t expected to change, no
-.-.
Put a parenthetical sentence, phrase on a separate line (if not part of a code),
see man-pages(7), item "semantic newline".
gdbus-codegen.1:61:output files. It currently supports generating C source code (via \fB\-\-body\fP) or
gdbus-codegen.1:62:header (via \fB\-\-header\fP) and DocBook XML (via \fB\-\-generate\-docbook\fP).
gdbus-codegen.1:64:just contain the interface information (as \fBGDBusInterfaceInfo\fP structures)
gdbus-codegen.1:106:\fB\-\-c\-namespace\fP option contains an underscore (sometimes called \fIUgly_Case\fP),
gdbus-codegen.1:189:\fB$(OUTDIR)/$(dirname $OUTFILES)/$(basename $OUTFILES).{c,h}\fP\&.
gdbus-codegen.1:316:guards or \fB#pragma once\fP (if \fB\-\-pragma\-once\fP is used). This is used if
gdbus-codegen.1:343:The full path where the header (\fB\-\-header\fP, \fB\-\-interface\-info\-header\fP) or
gdbus-codegen.1:344:the source code (\fB\-\-body\fP, \fB\-\-interface\-info\-body\fP) will be written, using
gdbus-codegen.1:426:If a method has \fBh\fP (file descriptor) parameter(s), a \fBGUnixFDList\fP
gdbus-codegen.1:651:#define MY_APP_TYPE_FROBBER (my_app_frobber_get_type ())
gdbus-codegen.1:652:#define MY_APP_TYPE_FROBBER_SKELETON (my_app_frobber_skeleton_get_type ())
gdbus-codegen.1:653:#define MY_APP_TYPE_FROBBER_PROXY (my_app_frobber_proxy_get_type ())
gdbus-codegen.1:662: void (*notification) (MyAppFrobber *proxy,
gdbus-codegen.1:668: gboolean (*handle_hello_world) (MyAppFrobber *proxy,
gdbus-codegen.1:710:gboolean my_app_frobber_get_verbose (MyAppFrobber *object);
gdbus-codegen.1:755:functions are generated (one setter, one getter) and one \fBGObject\fP property.
gdbus-codegen.1:880: if (g_strcmp0 (greeting, \(dqBoo\(dq) != 0)
gdbus-codegen.1:883: response = g_strdup_printf (\(dqWord! You said ???%s???.\(dq, greeting);
gdbus-codegen.1:884: my_app_complete_hello_world (interface, invocation, response);
gdbus-codegen.1:901: my_app_frobber_set_verbose (interface, TRUE);
gdbus-codegen.1:905: G_CALLBACK (on_handle_hello_world),
gdbus-codegen.1:911: if (!g_dbus_interface_skeleton_export (G_DBUS_INTERFACE_SKELETON (interface),
gdbus-codegen.1:922:To facilitate atomic changesets (multiple properties changing at the same time),
gdbus-codegen.1:936:\fBt\fP and \fBd\fP), strings (type strings \fBs\fP, \fBay\fP, \fBo\fP and \fBg\fP) and
gdbus-codegen.1:937:arrays of strings (type strings \fBas\fP, \fBao\fP and \fBaay\fP) are mapped to the
gdbus-codegen.1:944:convenient to use when using bytestrings (type string \fBay\fP) for data that
-.-.
Change a HYPHEN-MINUS (code 0x55, 2D) to a dash
(\-, minus) if it matches "[[:alph:]]-[[:alpha:]]" in the name of an
option).
Facilitates the copy and paste of an option in UTF-8 text.
Is not needed in ordinary words like "mother-in-law", that are not
copied and pasted to a command line (which needs ASCII code)
861:(documentation <https://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-properties>
942:(documentation <https://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-properties>
-.-.
Output from "test-groff -b -mandoc -rF0 -rHY=0 -K utf8 -t -ww -z ":
troff: backtrace: file '<stdin>':797
troff:<stdin>:797: warning: [page 9, 8.4i (diversion '3tbd2,2', 0.7i)]: cannot break line
troff: backtrace: file '<stdin>':998
troff:<stdin>:998: warning: trailing space in the line
More information about the pkg-gnome-maintainers
mailing list