linux-kernel - Re: [External] Re: [PATCH 31/32] Documentation: update sysfs-platform

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: <b7b95382-de15-7a55-6931-b4f6f786cfcf@redhat.com>
Date:   Thu, 1 Apr 2021 21:18:46 +0200
From:   Hans de Goede <hdegoede@...hat.com>
To:     Mark Pearson <markpearson@...ovo.com>,
        Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
        Linux Doc Mailing List <linux-doc@...r.kernel.org>
Cc:     Jonathan Corbet <corbet@....net>,
        "Rafael J. Wysocki" <rafael.j.wysocki@...el.com>,
        linux-kernel@...r.kernel.org
Subject: Re: [External] Re: [PATCH 31/32] Documentation: update
 sysfs-platform_profile.rst reference

Hi,

On 4/1/21 5:07 PM, Mark Pearson wrote:
> 
> 
> On 01/04/2021 09:49, Hans de Goede wrote:
>> Hi,
>>
>> On 4/1/21 2:17 PM, Mauro Carvalho Chehab wrote:
>>> The file name: Documentation/ABI/testing/sysfs-platform_profile.rst
>>> should be, instead: Documentation/userspace-api/sysfs-platform_profile.rst.
>>>
>>> Update its cross-reference accordingly.
>>>
>>> Fixes: a2ff95e018f1 ("ACPI: platform: Add platform profile support")
>>> Fixes: 8e0cbf356377 ("Documentation: Add documentation for new platform_profile sysfs attribute")
>>> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
>>
>> Thanks, patch looks good to me:
>>
>> Reviewed-by: Hans de Goede <hdegoede@...hat.com>
>>
>> Rafael, I assume you will merge this through your tree?
>>
>> Regards,
>>
>> Hans
>>
> Looks good to me too - though I'd missed the fact the file had moved
> somehow :)
> 
> Not sure if my reviewed tag has any value but if it's useful:
> Reviewed-by: Mark Pearson <markpearson@...ovo.com>
> 
> Just for my education - how do things get moved from testing to
> somewhere else, is there a decision process etc?

I'm not sure how things work with the new Documentation/userspace-api/
dir, but with the old Documentation/ABI/testing dir things used to go
like this (AFAICT):

1) A new sysfs API bindings starts in Documentation/ABI/testing
2) This sysfs API bindings then stays in Documentation/ABI/testing forever

And if the bindings were actually in use by userspace then they were being
treated as immutable / unbreakable API anyways so the testing prefix
had very little meaning really.

Which I guess may well be the reason why new the new place no
longer has a testing prefix.

Regards,

Hans



>>> ---
>>>  include/linux/platform_profile.h | 2 +-
>>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>>
>>> diff --git a/include/linux/platform_profile.h b/include/linux/platform_profile.h
>>> index a6329003aee7..e5cbb6841f3a 100644
>>> --- a/include/linux/platform_profile.h
>>> +++ b/include/linux/platform_profile.h
>>> @@ -2,7 +2,7 @@
>>>  /*
>>>   * Platform profile sysfs interface
>>>   *
>>> - * See Documentation/ABI/testing/sysfs-platform_profile.rst for more
>>> + * See Documentation/userspace-api/sysfs-platform_profile.rst for more
>>>   * information.
>>>   */
>>>  
>>>
>>
>