Re: [PATCH v3] doc: process: clarify scope of applying-patches as legacy reference

[Weijie Yuan <wy@wyuan.org>]

Oscar Alejandro Sánchez Lucero <aleszlucero@gmail.com> writes:

> The applying-patches.rst document describes the manual manipulation of
> source trees using the traditional 'patch' and 'diff' utilities. While
> technically accurate for non-Git or constrained environments, it can
> create friction for new contributors seeking the primary Git-based
> workflows.
> 
> Update the opening note to explicitly state that this document serves
> as a reference for legacy or constrained workflows. Provide a direct
> cross-reference to howto.rst to steer contributors toward the standard
> Git infrastructure.
> 
> Signed-off-by: Oscar Alejandro Sánchez Lucero <aleszlucero@gmail.com>
> ---
> Signed-off-by: AleSZLucero <aleszlucero@gmail.com>
> ---
> Changes in v3:
> - EDITME: describe what is new in this series revision.
> - EDITME: use bulletpoints and terse descriptions.
> - Link to v2: https://lore.kernel.org/r/20261104-doc-patch-fix-v2-1-3601fc35c505@gmail.com
> 
> Changes in v2:
> - EDITME: describe what is new in this series revision.
> - EDITME: use bulletpoints and terse descriptions.
> - Link to v1: https://lore.kernel.org/r/20261104-doc-patch-fix-v1-1-617cb9f4cd47@gmail.com
> ---

You may want to modify the EDITMEs. ;-)

>  Documentation/process/applying-patches.rst | 11 ++++++++---
>  1 file changed, 8 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/process/applying-patches.rst b/Documentation/process/applying-patches.rst
> index c269f5e1a0a3..59d16b4e0889 100644
> --- a/Documentation/process/applying-patches.rst
> +++ b/Documentation/process/applying-patches.rst
> @@ -8,8 +8,14 @@ Original by:
>  
>  .. note::
>  
> -   This document is obsolete.  In most cases, rather than using ``patch``
> -   manually, you'll almost certainly want to look at using Git instead.
> +   This document focuses on the legacy method of manually manipulating source 
> +   trees using the traditional ``patch`` and ``diff`` utilities. 
> +
> +   For the standard Git-based workflow used to clone the repository and work 
> +   with kernel patches, please refer to Documentation/process/howto.rst.
> +
> +   The information below is maintained as a reference for constrained 
> +   environments or legacy workflows where Git infrastructure is unavailable.

Yes, further explained the note added by Jon.

But I guess Jon's commit message is clear enough? --

"This is ancient stuff and we don't do things this way anymore.  In the
absence of simply deleting the document, at least add a warning to it."
(commit 67972a539e9f, "docs: Add a warning to applying-patches.rst")

It seems that there is no that great necessity for revisions, from my
perspective of reading experience. Thanks.