diff mbox series

[2/2] docparse: Unify Description and Algorithm titles

Message ID 20210308160122.24522-2-pvorel@suse.cz
State Accepted
Headers show
Series [1/2] docparse: Use C standard comment end | expand

Commit Message

Petr Vorel March 8, 2021, 4:01 p.m. UTC
Instead of fixing sources docs unify it during doc generation.

Signed-off-by: Petr Vorel <pvorel@suse.cz>
---
 docparse/testinfo.pl | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Xiao Yang March 11, 2021, 1:38 a.m. UTC | #1
On 2021/3/9 0:01, Petr Vorel wrote:
> Instead owo'n'df fixing sources docs unify it during doc generation.
Hi Petr,

Your fix unifies Description and Algorithm in metadata.{html, pdf}.
I wonder if we should do the conversion in metadata.json instead.

Best Regards,
Xiao Yang
> Signed-off-by: Petr Vorel<pvorel@suse.cz>
> ---
>   docparse/testinfo.pl | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/docparse/testinfo.pl b/docparse/testinfo.pl
> index b5ab02bc1..f3a657d4d 100755
> --- a/docparse/testinfo.pl
> +++ b/docparse/testinfo.pl
> @@ -308,7 +308,7 @@ sub content_all_tests
>
>   				# fix formatting for asciidoc [DOCUMENTATION] =>  *DOCUMENTATION*
>   				if ($doc =~ s/^\[(.*)\]$/$1/) {
> -					$doc = paragraph(bold($doc));
> +					$doc = paragraph(bold(ucfirst(lc($doc))));
>   				}
>
>   				$content .= "$doc\n";
Petr Vorel March 11, 2021, 6:44 a.m. UTC | #2
Hi Yang,

> On 2021/3/9 0:01, Petr Vorel wrote:
> > Instead owo'n'df fixing sources docs unify it during doc generation.
> Hi Petr,

> Your fix unifies Description and Algorithm in metadata.{html, pdf}.
> I wonder if we should do the conversion in metadata.json instead.
Yep, that could work as well. Not a strong opinion about it.

Kind regards,
Petr

> Best Regards,
> Xiao Yang
Cyril Hrubis March 12, 2021, 10:42 a.m. UTC | #3
Hi!
> diff --git a/docparse/testinfo.pl b/docparse/testinfo.pl
> index b5ab02bc1..f3a657d4d 100755
> --- a/docparse/testinfo.pl
> +++ b/docparse/testinfo.pl
> @@ -308,7 +308,7 @@ sub content_all_tests
>  
>  				# fix formatting for asciidoc [DOCUMENTATION] => *DOCUMENTATION*
                                                                                  ^
										  This
										  should
										  be
										  *Documentation*

>  				if ($doc =~ s/^\[(.*)\]$/$1/) {
> -					$doc = paragraph(bold($doc));
> +					$doc = paragraph(bold(ucfirst(lc($doc))));
>  				}
>  
>  				$content .= "$doc\n";

Other than that it looks good.

Reviewed-by: Cyril Hrubis <chrubis@suse.cz>
Petr Vorel March 12, 2021, 11:02 a.m. UTC | #4
Hi,

> >  				# fix formatting for asciidoc [DOCUMENTATION] => *DOCUMENTATION*
>                                                                                   ^
> 										  This
> 										  should
> 										  be
> 										  *Documentation*

> >  				if ($doc =~ s/^\[(.*)\]$/$1/) {
> > -					$doc = paragraph(bold($doc));
> > +					$doc = paragraph(bold(ucfirst(lc($doc))));
> >  				}

> >  				$content .= "$doc\n";

> Other than that it looks good.
Thanks, fixed and patchset merged.

Yang, sorry I didn't put it into docparse.c.

> Reviewed-by: Cyril Hrubis <chrubis@suse.cz>
Xiao Yang March 12, 2021, 2:52 p.m. UTC | #5
于 2021/3/12 19:02, Petr Vorel 写道:
> Hi,
>
>>>   				# fix formatting for asciidoc [DOCUMENTATION] =>  *DOCUMENTATION*
>>                                                                                    ^
>> 										  This
>> 										  should
>> 										  be
>> 										  *Documentation*
>>>   				if ($doc =~ s/^\[(.*)\]$/$1/) {
>>> -					$doc = paragraph(bold($doc));
>>> +					$doc = paragraph(bold(ucfirst(lc($doc))));
>>>   				}
>>>   				$content .= "$doc\n";
>> Other than that it looks good.
> Thanks, fixed and patchset merged.
>
> Yang, sorry I didn't put it into docparse.c.
Hi Petr,

Never mind, we can do it later when someone needs to unify these titles 
in metadata.json.

Best Regards,
Xiao Yang
>> Reviewed-by: Cyril Hrubis<chrubis@suse.cz>
>
> .
>
diff mbox series

Patch

diff --git a/docparse/testinfo.pl b/docparse/testinfo.pl
index b5ab02bc1..f3a657d4d 100755
--- a/docparse/testinfo.pl
+++ b/docparse/testinfo.pl
@@ -308,7 +308,7 @@  sub content_all_tests
 
 				# fix formatting for asciidoc [DOCUMENTATION] => *DOCUMENTATION*
 				if ($doc =~ s/^\[(.*)\]$/$1/) {
-					$doc = paragraph(bold($doc));
+					$doc = paragraph(bold(ucfirst(lc($doc))));
 				}
 
 				$content .= "$doc\n";