linux-kernel - Re: [PATCH] scripts: kernel-doc: transform documentation into POD

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20220103224806.2932bac2@fuji.fritz.box>
Date:   Mon, 3 Jan 2022 22:48:06 +0100
From:   Tomasz Warniełło <tomasz.warniello@...il.com>
To:     Jonathan Corbet <corbet@....net>
Cc:     Jani Nikula <jani.nikula@...ux.intel.com>,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] scripts: kernel-doc: transform documentation into POD

On Mon, 03 Jan 2022 13:04:09 -0700
Jonathan Corbet <corbet@....net> wrote:

> Tomasz Warniełło <tomasz.warniello@...il.com> writes:
> 
> > On Mon, 03 Jan 2022 11:04:53 +0200
> > Jani Nikula <jani.nikula@...ux.intel.com> wrote:  
> >> In kernel, tabs are 8 characters.
> >> 
> >> See Documentation/process/coding-style.rst
> >>   
> >
> > I am a heretic then.
> >
> > Except for the initial dogma, I understand and agree with the rationale
> > in coding-style.rst.
> >
> > Only what if I have stared at the screen not for 20 hours, but for
> > 40 hours? Now I want to have indentation even deeper, of 16 spaces.
> > And how do I get this having 8 spaces here and there instead of tabs?
> > The system begins to fall apart.
> >
> > The misleading statement is that tabs are 8 characters long. No. They
> > are exactly 1 character long. And that's ASCII 9.  
> 
> This is not particularly helpful.

Not helpful? In what matter? It is a matter of fact opinion on
coding-style.rst, which Jani Nikula referred to, so I think it is both
in topic and may be helpful to some. While troublesome to some others,
that's true.

> I would like to get your work in, but need some cooperation to get
> there.
> 
> Please:
> 
>  - Post your patch series as a single thread with a coherent cover
>    letter.

Sorry, I'm a newbie in this business. I need to figure out how emails
work. Is this just one thread per version or one thread per all versions?
Can you please direct me to some documentation about this?

>  - Stick with current coding conventions

To be honest, I need to think this over.

>  - Avoid snide comments to reviewers.

My reply is no more snide than coding-style.rst. Compare them. It strictly
relates to it. I don't point my answer at the reviewer in any way, if that's
what you mean.

Ch, TW