Re: [PATCH] docs: Remove "could not extract kernel version" warning

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Mon, 11 Dec 2017, Randy Dunlap <rdunlap@xxxxxxxxxxxxx> wrote:
> On 12/11/2017 02:24 PM, Jonathan Corbet wrote:
>> This warning will happen for every normal kernel docs build and doesn't
>> carry any useful information.  Should anybody actually depend on this
>> "version" variable (which isn't clear to me), the "unknown version" value
>> will be clue enough.
>
> Yay.  I looked at that last week and got nowhere with it.

The whole try block was for when sphinx-build is run directly, e.g. when
run by Read the Docs or manually on the command line. But looking at all
the Makefile sauce we've accumulated, we're probably way, *way* beyond
the point where building the docs is in any way feasible by running
sphinx-build directly.

The Makefile passes version and release on the sphinx-build command line
in our normal build, so we could just remove the try block
altogether. It's more like a fallback hack anyway.

The version shows up in the built documentation, depending on the theme.

Nothing wrong with this patch, but could go further.

BR,
Jani.


>
>> Signed-off-by: Jonathan Corbet <corbet@xxxxxxx>
>> ---
>>  Documentation/conf.py | 1 -
>>  1 file changed, 1 deletion(-)
>> 
>> diff --git a/Documentation/conf.py b/Documentation/conf.py
>> index 63857d33778c..62ac5a9f3a9f 100644
>> --- a/Documentation/conf.py
>> +++ b/Documentation/conf.py
>> @@ -88,7 +88,6 @@ finally:
>>      if makefile_version and makefile_patchlevel:
>>          version = release = makefile_version + '.' + makefile_patchlevel
>>      else:
>> -        sys.stderr.write('Warning: Could not extract kernel version\n')
>>          version = release = "unknown version"
>>  
>>  # The language for content autogenerated by Sphinx. Refer to documentation
>> 

-- 
Jani Nikula, Intel Open Source Technology Center
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux