Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
MIME-Version: 1.0
References: <20191121191536.186051-1-pterjan@google.com> <20191122100844.2e9b22c6@lwn.net>
In-Reply-To: <20191122100844.2e9b22c6@lwn.net>
From:   Pascal Terjan <pterjan@google.com>
Date:   Sat, 23 Nov 2019 16:48:42 +0000
Message-ID: <CAANdO=KoAPXh+ZuXOW7XMibvbTchj96vr_aEUtqEDg-H2OVmHw@mail.gmail.com>
Subject: Re: [PATCH] Delete obsolete magic constants from documentation
To:     Jonathan Corbet <corbet@lwn.net>
Cc:     Federico Vaga <federico.vaga@vaga.pv.it>,
        Harry Wei <harryxiyou@gmail.com>, linux-doc@vger.kernel.org,
        linux-kernel@vger.kernel.org
Content-Type: text/plain; charset="UTF-8"
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

On Fri, 22 Nov 2019 at 17:08, Jonathan Corbet <corbet@lwn.net> wrote:
>
> On Thu, 21 Nov 2019 19:15:36 +0000
> Pascal Terjan <pterjan@google.com> wrote:
>
> > Those no longer appear in the code.
> > I have some more patches to cleanup some of them from the code but this
> > is an easy first step.
> >
> > Signed-off-by: Pascal Terjan <pterjan@google.com>
> > ---
> >  Documentation/process/magic-number.rst        | 44 -------------------
> >  .../it_IT/process/magic-number.rst            | 44 -------------------
> >  .../zh_CN/process/magic-number.rst            | 44 -------------------
> >  3 files changed, 132 deletions(-)
>
> So I absolutely love this patch; we really need to clean this kind of
> cruft out of the docs.
>
> Unfortunately, it doesn't apply to docs-next; did you prepare it against
> linux-next, perhaps?  Is there any chance I could get a version against
> docs-next?

Right, that probably because of the lack of my previous patch
https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git/commit/?id=fba67e8f897870403e1a4f5fe3835c870cd589e0
which hasn't finished its journey yet

I am not sure how to proceed as there are a few other patches for
various subsystems I am planning to send out (like deleting
RFCOMM_TTY_MAGIC from net/bluetooth/rfcomm/tty.c or GDTIOCTL_MAGIC
from drivers/scsi/gdth_ioctl.h) which will also be touching this file
and I'd rather not cause some merge problems...
Maybe I should not update the documentation in the patches removing
the constants from the code and clean it up separately?

> If you're up for further work on this file, it would be nice to get rid of
> the 2.x "changelog" text at the beginning; I don't think that has any real
> value now.

Sure, I picked this file and initially started cleaning it up,
including deleting that changelog, but then decided to first clean up
the code referencing some of those constants without using them.
There are lots of other things to delete in this file, like references
to OSS and maybe even the file itself given that the practice of using
a magic field in structs is no longer common, but I can start sending
a few simple cleanups.

> Thanks,
>
> jon