[systemd-devel] journald API documentation

[Zbigniew Jędrzejewski-Szmek]

On 06/27/2012 11:28 AM, Lennart Poettering wrote:
> On Tue, 26.06.12 17:31, David Strauss (david at davidstrauss.net) wrote:
> 
>> I would like to document the native journald API with some usage
>> examples. Would this be best handled in the form of a man page,
>> comments in the main header file, or elsewhere?
> 
> Awesome, much appreciated!
> 
> I think this would be best done in the same way as sd-daemon and
> sd-login are already handled: as man pages, with one introductory page
> sd-journal(7) plus individual mn pages for the function calls. The
> function calls should be grouped so that similar calls get a single man
> page only. For exampe, sd_journal_open() and sd_journal_close() should
> be a single man page, or sd_journal_previous(), sd_journal_next(),
> sd_journal_previous_skip() and sd_journal_next_skip() be another.
Hi,

I've been playing around with the python journald client, and I'm not
entirely clear on a few API details. I think it would be nice if the new
documentation cleared them up:

1. If the iovect passed to sd_journal_sendv() doesn't contain MESSAGE=
field, the whole request seems to be ignored. And no error is thrown. Is
this expected?

2. The documentation mentions ASCII as the coding, but shouldn't the
messages rather be standardized on UTF-8? And also, is there a way for
the reader to know, which attributes are binary? Is there some convention?

Thanks,
Zbyszek