<div dir="ltr">> Can you explain which errors did you get? I tried pod2markdown on a<br>> couple of API longdesc's, and the result seemed OK.<br>> Most probably we will need to write our own pod2markdown though, as<br>> pod2markdown does not allow users to customize all the options that<br>> the Pod::Markdown module has.<br><div><br></div><div>Yes. Most of the results seemed OK. But, for example, translating 'docs/guestfs-internals.pod' dumps the following errors at the end of the output file</div><div><br></div><div>```</div><div># POD ERRORS<br><br>Hey! **The above document had some coding errors, which are explained below:**<br><br>- Around line 17:<br><br>    Non-ASCII character seen before =encoding in '┌───────────────────┐'. Assuming UTF-8<br></div><div>```</div><div><br></div><div>I do not know whether there are such non-ascii characters in API longdescs, and I have no idea to find </div><div>such characters easily. So, I am not able to say whether pod2markdown is usable or not for now...</div><div><br></div><div><br></div><div>> IMHO it is better to produce the code directly following</div>> the style conventions.<div><br></div><div>OK. I'll send the formatting patch.</div><div><br></div><div>Regards,</div><div>Hiroyuki<div><br></div></div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">2019年8月13日(火) 19:44 Pino Toscano <<a href="mailto:ptoscano@redhat.com">ptoscano@redhat.com</a>>:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">On Tuesday, 13 August 2019 05:17:10 CEST Katsura Hiroyuki wrote:<br>
> <br>
> > 2019/08/13 1:01、Pino Toscano <<a href="mailto:ptoscano@redhat.com" target="_blank">ptoscano@redhat.com</a>>のメール:<br>
> > <br>
> > On Sunday, 11 August 2019 06:42:21 CEST Hiroyuki Katsura wrote:<br>
> >> `cargo doc` will generate docs with long descriptions.<br>
> > <br>
> > This is a nice start, although most probably it will not look that good<br>
> > though (since the plain text output may be misrendered as markdown).<br>
> > <br>
> > I remember we talked about converting the POD texts to markdown, and<br>
> > that there seems to be something we can use:<br>
> > <a href="https://metacpan.org/release/Pod-Markdown" rel="noreferrer" target="_blank">https://metacpan.org/release/Pod-Markdown</a> <<a href="https://metacpan.org/release/Pod-Markdown" rel="noreferrer" target="_blank">https://metacpan.org/release/Pod-Markdown</a>><br>
> > Did you try to use it?  What were the results?<br>
> <br>
> Yes. As I mentioned before, it looked pretty good except for some encode-errors.<br>
> However, at first, I just translate pod to text by the exisiting function because using <br>
> pod2markdown looks a little tricky.<br>
<br>
Can you explain which errors did you get? I tried pod2markdown on a<br>
couple of API longdesc's, and the result seemed OK.<br>
Most probably we will need to write our own pod2markdown though, as<br>
pod2markdown does not allow users to customize all the options that<br>
the Pod::Markdown module has.<br>
<br>
> Question: <br>
> There are some places where the length of the line in the generated code<br>
> is over 100 characters. Of course, I can try to make the length of each line under 100 <br>
> characters. However, there is a nice tool: ‘rustfmt.’ I want to use this as a ‘post-process’ <br>
> of generating bindings. Is it OK?(I should have ask you when I sent the first patch)<br>
<br>
Considering we are generating most of the rust code using the<br>
generator, IMHO it is better to produce the code directly following<br>
the style conventions. I just checked the difference between our<br>
currently generated <a href="http://guestfs.rs" rel="noreferrer" target="_blank">guestfs.rs</a> and the "formatted" version of it, and<br>
fixing <a href="http://guestfs.rs" rel="noreferrer" target="_blank">guestfs.rs</a> does not seem too difficult. It can be done in steps,<br>
of course, no need to rush everything in a single fix.<br>
<br>
-- <br>
Pino Toscano</blockquote></div>