linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Ignacio Peña" <ignacio.pena87@gmail.com>
To: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] Documentation: Add patch-validator to dev-tools
Date: Thu, 17 Jul 2025 12:29:48 -0400	[thread overview]
Message-ID: <20250717162948.23078-1-ignacio.pena87@gmail.com> (raw)
In-Reply-To: <87wmjy92r6.fsf@trenco.lwn.net>

On Thu, Jul 17, 2025 at 09:38:00AM -0600, Jonathan Corbet wrote:
> Interesting ... overall, we don't generally have detailed documentation
> for out-of-tree utilities, though there isn't necessarily any reason why
> we couldn't.  But I'm curious as to why you haven't submitted the tool
> itself?

That's a great question! I kept it external for a few reasons:

First, I'm still pretty new to kernel development and wanted the freedom
to iterate quickly as I learn what checks are actually useful. Being 
external means I can push updates immediately when someone points out
a new common mistake (like Greg just did with the date check!).

Second, I wrote everything in bash for simplicity, which probably isn't
the best fit for the kernel's scripts/ directory. Plus, as Greg mentioned
in his reply, many of these checks really belong in checkpatch.pl rather
than a separate tool.

So my plan now is to work on patches for checkpatch.pl to add the most
useful checks there (where they belong), while keeping the workflow 
helpers as an external toolkit.

Given this direction, would you prefer I withdraw this documentation 
patch? I'm happy either way - just thought it might help other newcomers
in the meantime, but I totally understand if you'd rather wait until
the checks are properly integrated into checkpatch.pl.

Thanks for reviewing this!

Thanks,
Ignacio

       reply	other threads:[~2025-07-17 16:29 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <87wmjy92r6.fsf@trenco.lwn.net>
2025-07-17 16:29 ` Ignacio Peña [this message]
2025-07-17 19:41   ` [PATCH] Documentation: Add patch-validator to dev-tools Jonathan Corbet
2025-07-17  7:47 Ignacio Peña
2025-07-17 13:38 ` Jonathan Corbet

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=20250717162948.23078-1-ignacio.pena87@gmail.com \
    --to=ignacio.pena87@gmail.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /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 NNTP newsgroup(s).