| Message ID | 20230705133139.54419-2-philmd@linaro.org |
|---|---|
| State | New |
| Headers | show |
| Series | chardev/char-fe: Document FEWatchFunc and use G_SOURCE_CONTINUE/REMOVE | expand |
On Wed, Jul 05, 2023 at 03:31:36PM +0200, Philippe Mathieu-Daudé wrote: > One can get lost looking for "public API docs". Explicit > we are referring to GLib IOChannel documentation. > > Signed-off-by: Philippe Mathieu-Daudé <philmd@linaro.org> > --- > include/io/channel.h | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/include/io/channel.h b/include/io/channel.h > index 229bf36910..998718b470 100644 > --- a/include/io/channel.h > +++ b/include/io/channel.h > @@ -97,7 +97,7 @@ struct QIOChannel { > * The first five callbacks are mandatory to support, others > * provide additional optional features. > * > - * Consult the corresponding public API docs for a description > + * Consult the corresponding GLib IOChannel public API docs for a description This is refering to the public API docs in this very file. ie for io_writev callback, the qio_channel_io_writev docs define semantics. > * of the semantics of each callback. io_shutdown in particular > * must be thread-safe, terminate quickly and must not block. > */ > -- > 2.38.1 > With regards, Daniel
diff --git a/include/io/channel.h b/include/io/channel.h index 229bf36910..998718b470 100644 --- a/include/io/channel.h +++ b/include/io/channel.h @@ -97,7 +97,7 @@ struct QIOChannel { * The first five callbacks are mandatory to support, others * provide additional optional features. * - * Consult the corresponding public API docs for a description + * Consult the corresponding GLib IOChannel public API docs for a description * of the semantics of each callback. io_shutdown in particular * must be thread-safe, terminate quickly and must not block. */
One can get lost looking for "public API docs". Explicit we are referring to GLib IOChannel documentation. Signed-off-by: Philippe Mathieu-Daudé <philmd@linaro.org> --- include/io/channel.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)