diff mbox

[ovs-dev] docs: Refer to correct package name for sphinx theme.

Message ID 20170721002321.19576-1-russell@ovn.org
State Accepted
Headers show

Commit Message

Russell Bryant July 21, 2017, 12:23 a.m. UTC
Update the log message emitted when the OVS sphinx theme is not found
to reference the name of the package to be installed via pip:
ovs-sphinx-theme.

Signed-off-by: Russell Bryant <russell@ovn.org>
---
 Documentation/conf.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Lance Richardson July 26, 2017, 8:29 p.m. UTC | #1
> From: "Russell Bryant" <russell@ovn.org>
> To: dev@openvswitch.org
> Sent: Thursday, 20 July, 2017 8:23:21 PM
> Subject: [ovs-dev] [PATCH] docs: Refer to correct package name for sphinx	theme.
> 
> Update the log message emitted when the OVS sphinx theme is not found
> to reference the name of the package to be installed via pip:
> ovs-sphinx-theme.
> 
> Signed-off-by: Russell Bryant <russell@ovn.org>
> ---
>  Documentation/conf.py | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/conf.py b/Documentation/conf.py
> index 77c4df5c0..3621c4867 100644
> --- a/Documentation/conf.py
> +++ b/Documentation/conf.py
> @@ -19,7 +19,7 @@ try:
>      import ovs_sphinx_theme
>      use_ovs_theme = True
>  except ImportError:
> -    print("Cannot find 'ovs_sphinx' package. Falling back to default
> theme.")
> +    print("Cannot find 'ovs-sphinx-theme' package. Falling back to default
> theme.")
>      use_ovs_theme = False
>  
>  # -- General configuration ------------------------------------------------
> --
> 2.13.3
> 
> _______________________________________________
> dev mailing list
> dev@openvswitch.org
> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
> 

I didn't know there was an "ovs-sphinx-theme" package to install before looking
at this. LGTM.

Acked-by: Lance Richardson <lrichard@redhat.com>
Russell Bryant July 26, 2017, 8:32 p.m. UTC | #2
On Wed, Jul 26, 2017 at 4:29 PM, Lance Richardson <lrichard@redhat.com> wrote:
>> From: "Russell Bryant" <russell@ovn.org>
>> To: dev@openvswitch.org
>> Sent: Thursday, 20 July, 2017 8:23:21 PM
>> Subject: [ovs-dev] [PATCH] docs: Refer to correct package name for sphinx     theme.
>>
>> Update the log message emitted when the OVS sphinx theme is not found
>> to reference the name of the package to be installed via pip:
>> ovs-sphinx-theme.
>>
>> Signed-off-by: Russell Bryant <russell@ovn.org>
>> ---
>>  Documentation/conf.py | 2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/Documentation/conf.py b/Documentation/conf.py
>> index 77c4df5c0..3621c4867 100644
>> --- a/Documentation/conf.py
>> +++ b/Documentation/conf.py
>> @@ -19,7 +19,7 @@ try:
>>      import ovs_sphinx_theme
>>      use_ovs_theme = True
>>  except ImportError:
>> -    print("Cannot find 'ovs_sphinx' package. Falling back to default
>> theme.")
>> +    print("Cannot find 'ovs-sphinx-theme' package. Falling back to default
>> theme.")
>>      use_ovs_theme = False
>>
>>  # -- General configuration ------------------------------------------------
>> --
>> 2.13.3
>>
>> _______________________________________________
>> dev mailing list
>> dev@openvswitch.org
>> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
>>
>
> I didn't know there was an "ovs-sphinx-theme" package to install before looking
> at this. LGTM.
>
> Acked-by: Lance Richardson <lrichard@redhat.com>

Thanks!  Applied to master.
Joe Stringer July 26, 2017, 9:45 p.m. UTC | #3
On 26 July 2017 at 13:32, Russell Bryant <russell@ovn.org> wrote:
> On Wed, Jul 26, 2017 at 4:29 PM, Lance Richardson <lrichard@redhat.com> wrote:
>>> From: "Russell Bryant" <russell@ovn.org>
>>> To: dev@openvswitch.org
>>> Sent: Thursday, 20 July, 2017 8:23:21 PM
>>> Subject: [ovs-dev] [PATCH] docs: Refer to correct package name for sphinx     theme.
>>>
>>> Update the log message emitted when the OVS sphinx theme is not found
>>> to reference the name of the package to be installed via pip:
>>> ovs-sphinx-theme.
>>>
>>> Signed-off-by: Russell Bryant <russell@ovn.org>
>>> ---
>>>  Documentation/conf.py | 2 +-
>>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>>
>>> diff --git a/Documentation/conf.py b/Documentation/conf.py
>>> index 77c4df5c0..3621c4867 100644
>>> --- a/Documentation/conf.py
>>> +++ b/Documentation/conf.py
>>> @@ -19,7 +19,7 @@ try:
>>>      import ovs_sphinx_theme
>>>      use_ovs_theme = True
>>>  except ImportError:
>>> -    print("Cannot find 'ovs_sphinx' package. Falling back to default
>>> theme.")
>>> +    print("Cannot find 'ovs-sphinx-theme' package. Falling back to default
>>> theme.")
>>>      use_ovs_theme = False
>>>
>>>  # -- General configuration ------------------------------------------------
>>> --
>>> 2.13.3
>>>
>>> _______________________________________________
>>> dev mailing list
>>> dev@openvswitch.org
>>> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
>>>
>>
>> I didn't know there was an "ovs-sphinx-theme" package to install before looking
>> at this. LGTM.
>>
>> Acked-by: Lance Richardson <lrichard@redhat.com>
>
> Thanks!  Applied to master.

Hi Russell,

It looks like the new line is too long, which means that if you don't
have the theme installed you get compilation failures:

../Documentation/conf.py:22:80: E501 line too long (83 > 79 characters)
Russell Bryant July 27, 2017, 12:28 a.m. UTC | #4
On Wed, Jul 26, 2017 at 5:45 PM, Joe Stringer <joe@ovn.org> wrote:
> On 26 July 2017 at 13:32, Russell Bryant <russell@ovn.org> wrote:
>> On Wed, Jul 26, 2017 at 4:29 PM, Lance Richardson <lrichard@redhat.com> wrote:
>>>> From: "Russell Bryant" <russell@ovn.org>
>>>> To: dev@openvswitch.org
>>>> Sent: Thursday, 20 July, 2017 8:23:21 PM
>>>> Subject: [ovs-dev] [PATCH] docs: Refer to correct package name for sphinx     theme.
>>>>
>>>> Update the log message emitted when the OVS sphinx theme is not found
>>>> to reference the name of the package to be installed via pip:
>>>> ovs-sphinx-theme.
>>>>
>>>> Signed-off-by: Russell Bryant <russell@ovn.org>
>>>> ---
>>>>  Documentation/conf.py | 2 +-
>>>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>>>
>>>> diff --git a/Documentation/conf.py b/Documentation/conf.py
>>>> index 77c4df5c0..3621c4867 100644
>>>> --- a/Documentation/conf.py
>>>> +++ b/Documentation/conf.py
>>>> @@ -19,7 +19,7 @@ try:
>>>>      import ovs_sphinx_theme
>>>>      use_ovs_theme = True
>>>>  except ImportError:
>>>> -    print("Cannot find 'ovs_sphinx' package. Falling back to default
>>>> theme.")
>>>> +    print("Cannot find 'ovs-sphinx-theme' package. Falling back to default
>>>> theme.")
>>>>      use_ovs_theme = False
>>>>
>>>>  # -- General configuration ------------------------------------------------
>>>> --
>>>> 2.13.3
>>>>
>>>> _______________________________________________
>>>> dev mailing list
>>>> dev@openvswitch.org
>>>> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
>>>>
>>>
>>> I didn't know there was an "ovs-sphinx-theme" package to install before looking
>>> at this. LGTM.
>>>
>>> Acked-by: Lance Richardson <lrichard@redhat.com>
>>
>> Thanks!  Applied to master.
>
> Hi Russell,
>
> It looks like the new line is too long, which means that if you don't
> have the theme installed you get compilation failures:
>
> ../Documentation/conf.py:22:80: E501 line too long (83 > 79 characters)

Sorry about that ... I just did a fresh Linux install on my laptop and
hadn't installed flake8.  I'll fix asap.
Russell Bryant July 27, 2017, 12:33 a.m. UTC | #5
On Wed, Jul 26, 2017 at 8:28 PM, Russell Bryant <russell@ovn.org> wrote:
> On Wed, Jul 26, 2017 at 5:45 PM, Joe Stringer <joe@ovn.org> wrote:
>> On 26 July 2017 at 13:32, Russell Bryant <russell@ovn.org> wrote:
>>> On Wed, Jul 26, 2017 at 4:29 PM, Lance Richardson <lrichard@redhat.com> wrote:
>>>>> From: "Russell Bryant" <russell@ovn.org>
>>>>> To: dev@openvswitch.org
>>>>> Sent: Thursday, 20 July, 2017 8:23:21 PM
>>>>> Subject: [ovs-dev] [PATCH] docs: Refer to correct package name for sphinx     theme.
>>>>>
>>>>> Update the log message emitted when the OVS sphinx theme is not found
>>>>> to reference the name of the package to be installed via pip:
>>>>> ovs-sphinx-theme.
>>>>>
>>>>> Signed-off-by: Russell Bryant <russell@ovn.org>
>>>>> ---
>>>>>  Documentation/conf.py | 2 +-
>>>>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>>>>
>>>>> diff --git a/Documentation/conf.py b/Documentation/conf.py
>>>>> index 77c4df5c0..3621c4867 100644
>>>>> --- a/Documentation/conf.py
>>>>> +++ b/Documentation/conf.py
>>>>> @@ -19,7 +19,7 @@ try:
>>>>>      import ovs_sphinx_theme
>>>>>      use_ovs_theme = True
>>>>>  except ImportError:
>>>>> -    print("Cannot find 'ovs_sphinx' package. Falling back to default
>>>>> theme.")
>>>>> +    print("Cannot find 'ovs-sphinx-theme' package. Falling back to default
>>>>> theme.")
>>>>>      use_ovs_theme = False
>>>>>
>>>>>  # -- General configuration ------------------------------------------------
>>>>> --
>>>>> 2.13.3
>>>>>
>>>>> _______________________________________________
>>>>> dev mailing list
>>>>> dev@openvswitch.org
>>>>> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
>>>>>
>>>>
>>>> I didn't know there was an "ovs-sphinx-theme" package to install before looking
>>>> at this. LGTM.
>>>>
>>>> Acked-by: Lance Richardson <lrichard@redhat.com>
>>>
>>> Thanks!  Applied to master.
>>
>> Hi Russell,
>>
>> It looks like the new line is too long, which means that if you don't
>> have the theme installed you get compilation failures:
>>
>> ../Documentation/conf.py:22:80: E501 line too long (83 > 79 characters)
>
> Sorry about that ... I just did a fresh Linux install on my laptop and
> hadn't installed flake8.  I'll fix asap.

Should be fixed in master now.  Thanks for pointing it out.
Joe Stringer July 27, 2017, 12:44 a.m. UTC | #6
On 26 July 2017 at 17:33, Russell Bryant <russell@ovn.org> wrote:
> On Wed, Jul 26, 2017 at 8:28 PM, Russell Bryant <russell@ovn.org> wrote:
>> On Wed, Jul 26, 2017 at 5:45 PM, Joe Stringer <joe@ovn.org> wrote:
>>> On 26 July 2017 at 13:32, Russell Bryant <russell@ovn.org> wrote:
>>>> On Wed, Jul 26, 2017 at 4:29 PM, Lance Richardson <lrichard@redhat.com> wrote:
>>>>>> From: "Russell Bryant" <russell@ovn.org>
>>>>>> To: dev@openvswitch.org
>>>>>> Sent: Thursday, 20 July, 2017 8:23:21 PM
>>>>>> Subject: [ovs-dev] [PATCH] docs: Refer to correct package name for sphinx     theme.
>>>>>>
>>>>>> Update the log message emitted when the OVS sphinx theme is not found
>>>>>> to reference the name of the package to be installed via pip:
>>>>>> ovs-sphinx-theme.
>>>>>>
>>>>>> Signed-off-by: Russell Bryant <russell@ovn.org>
>>>>>> ---
>>>>>>  Documentation/conf.py | 2 +-
>>>>>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>>>>>
>>>>>> diff --git a/Documentation/conf.py b/Documentation/conf.py
>>>>>> index 77c4df5c0..3621c4867 100644
>>>>>> --- a/Documentation/conf.py
>>>>>> +++ b/Documentation/conf.py
>>>>>> @@ -19,7 +19,7 @@ try:
>>>>>>      import ovs_sphinx_theme
>>>>>>      use_ovs_theme = True
>>>>>>  except ImportError:
>>>>>> -    print("Cannot find 'ovs_sphinx' package. Falling back to default
>>>>>> theme.")
>>>>>> +    print("Cannot find 'ovs-sphinx-theme' package. Falling back to default
>>>>>> theme.")
>>>>>>      use_ovs_theme = False
>>>>>>
>>>>>>  # -- General configuration ------------------------------------------------
>>>>>> --
>>>>>> 2.13.3
>>>>>>
>>>>>> _______________________________________________
>>>>>> dev mailing list
>>>>>> dev@openvswitch.org
>>>>>> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
>>>>>>
>>>>>
>>>>> I didn't know there was an "ovs-sphinx-theme" package to install before looking
>>>>> at this. LGTM.
>>>>>
>>>>> Acked-by: Lance Richardson <lrichard@redhat.com>
>>>>
>>>> Thanks!  Applied to master.
>>>
>>> Hi Russell,
>>>
>>> It looks like the new line is too long, which means that if you don't
>>> have the theme installed you get compilation failures:
>>>
>>> ../Documentation/conf.py:22:80: E501 line too long (83 > 79 characters)
>>
>> Sorry about that ... I just did a fresh Linux install on my laptop and
>> hadn't installed flake8.  I'll fix asap.
>
> Should be fixed in master now.  Thanks for pointing it out.

Thanks for fixing it :)
diff mbox

Patch

diff --git a/Documentation/conf.py b/Documentation/conf.py
index 77c4df5c0..3621c4867 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -19,7 +19,7 @@  try:
     import ovs_sphinx_theme
     use_ovs_theme = True
 except ImportError:
-    print("Cannot find 'ovs_sphinx' package. Falling back to default theme.")
+    print("Cannot find 'ovs-sphinx-theme' package. Falling back to default theme.")
     use_ovs_theme = False
 
 # -- General configuration ------------------------------------------------