From: Quentin Schulz <quentin.schulz@theobroma-systems.com>
To: Michael Opdenacker <michael.opdenacker@bootlin.com>
Cc: docs@lists.yoctoproject.org
Subject: Re: [docs] [PATCH 2/4] manuals: remove tab characters
Date: Tue, 2 Apr 2024 17:23:36 +0200 [thread overview]
Message-ID: <0f9c617d-13cf-4d2e-90e8-43e661bdf21e@theobroma-systems.com> (raw)
In-Reply-To: <90f9bf1d-1cd1-4b42-8af8-41ab7dd5ed5d@bootlin.com>
Hi Michael,
On 4/2/24 15:33, Michael Opdenacker wrote:
> Hi Quentin,
>
> Thanks for the review!
>
> On 4/2/24 at 11:58, Quentin Schulz wrote:
>>
>>> --- a/documentation/kernel-dev/common.rst
>>> +++ b/documentation/kernel-dev/common.rst
>>> @@ -1674,10 +1674,10 @@ looks much like the one provided with the
>>> ``hello-mod`` template::
>>> SRC := $(shell pwd)
>>> all:
>>> - $(MAKE) -C $(KERNEL_SRC) M=$(SRC)
>>> + $(MAKE) -C $(KERNEL_SRC) M=$(SRC)
>>> modules_install:
>>> - $(MAKE) -C $(KERNEL_SRC) M=$(SRC) modules_install
>>> + $(MAKE) -C $(KERNEL_SRC) M=$(SRC) modules_install
>>> ...
>>
>> I think this is actually incorrect.
>>
>> Makefile indentation is tab and not space, so this won't work. (This
>> is not the only piece of Makefile where this new indent shouldn't be
>> used though, so please be careful about others).
>
>
> Does this matter? If you look at
Well, yes, it does matter :D
> https://docs.yoctoproject.org/kernel-dev/common.html, which was built from the Sphinx sources which still have tabs, Sphinx replaced the tabs by spaces anyway. So, in any case, this isn't usable as an example we can copy and paste from the HTML documentation.
>
but that's a fair point. I wasn't aware of that. I guess that makes it a
Reviewed-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
> What about replacing the spaces by "<tab>" here? At least, though not
> syntactically correct in raw form, people would understand that a tab is
> needed there.
Mmmmm, not sure this'll help with readability. But nothing better to
suggest.
FYI, we use sphinx-copybutton in our user manuals to allow easy
copy-pasting, maybe something we could do for the docs as well :)
Cheers,
Quentin
next prev parent reply other threads:[~2024-04-02 15:23 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-30 18:08 [PATCH 1/4] manuals: fix trailing spaces michael.opdenacker
2024-03-30 18:08 ` [PATCH 2/4] manuals: remove tab characters michael.opdenacker
2024-04-02 9:58 ` [docs] " Quentin Schulz
2024-04-02 13:33 ` Michael Opdenacker
2024-04-02 15:23 ` Quentin Schulz [this message]
2024-03-30 18:08 ` [PATCH 3/4] manuals: fix incorrect double backticks michael.opdenacker
2024-03-30 18:08 ` [PATCH 4/4] migration-guides: add missing opening tag colon michael.opdenacker
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=0f9c617d-13cf-4d2e-90e8-43e661bdf21e@theobroma-systems.com \
--to=quentin.schulz@theobroma-systems.com \
--cc=docs@lists.yoctoproject.org \
--cc=michael.opdenacker@bootlin.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).