diff mbox series

[ovs-dev,v3] documentation: add sudo to install

Message ID 20210407194304.2886010-1-aidan.shribman@gmail.com
State Superseded
Headers show
Series [ovs-dev,v3] documentation: add sudo to install | expand

Commit Message

Aidan Shribman April 7, 2021, 7:43 p.m. UTC
From: hunchback <aidan.shribman@gmail.com>

add documentation of install sequence sudo to support running install
sequence as non-root user

Signed-off-by: Aidan Shribman <aidan.shribman@gmail.com>
---
 Documentation/intro/install/general.rst | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

Comments

0-day Robot April 7, 2021, 7:58 p.m. UTC | #1
Bleep bloop.  Greetings Aidan Shribman, I am a robot and I have tried out your patch.
Thanks for your contribution.

I encountered some error that I wasn't expecting.  See the details below.


checkpatch:
ERROR: Author hunchback <aidan.shribman@gmail.com> needs to sign off.
WARNING: Unexpected sign-offs from developers who are not authors or co-authors or committers: Aidan Shribman <aidan.shribman@gmail.com>
Lines checked: 59, Warnings: 1, Errors: 1


Please check this out.  If you feel there has been an error, please email aconole@redhat.com

Thanks,
0-day Robot
Mark Gray April 7, 2021, 9:27 p.m. UTC | #2
On 07/04/2021 20:43, Aidan Shribman wrote:
> From: hunchback <aidan.shribman@gmail.com>
> 
> add documentation of install sequence sudo to support running install
> sequence as non-root user
> 
> Signed-off-by: Aidan Shribman <aidan.shribman@gmail.com>
> ---
>  Documentation/intro/install/general.rst | 14 +++++++-------
>  1 file changed, 7 insertions(+), 7 deletions(-)
> 
> diff --git a/Documentation/intro/install/general.rst b/Documentation/intro/install/general.rst
> index 08a03a632..ee4827242 100644
> --- a/Documentation/intro/install/general.rst
> +++ b/Documentation/intro/install/general.rst
> @@ -371,7 +371,7 @@ Building
>  3. Run ``make install`` to install the executables and manpages into the
>     running system, by default under ``/usr/local``::
>  
> -       $ make install
> +       $ sudo make install

Maybe the prompt could be changed to "#" to imply root privileges?
>  
>  .. _general-starting:
>  
> @@ -422,23 +422,23 @@ Before starting ovn-northd you need to start OVN Northbound and Southbound
>  ovsdb-servers. Before ovsdb-servers can be started,
>  configure the Northbound and Southbound databases::
>  
> -       $ mkdir -p /usr/local/etc/ovn
> -       $ ovsdb-tool create /usr/local/etc/ovn/ovnnb_db.db \
> +       $ sudo mkdir -p /usr/local/etc/ovn
> +       $ sudo ovsdb-tool create /usr/local/etc/ovn/ovnnb_db.db \
>           ovn-nb.ovsschema
> -       $ ovsdb-tool create /usr/local/etc/ovn/ovnsb_db.db \
> +       $ sudo ovsdb-tool create /usr/local/etc/ovn/ovnsb_db.db \
>           ovn-sb.ovsschema
>  
>  Configure ovsdb-servers to use databases created above, to listen on a Unix
>  domain socket and to use the SSL configuration in the database::
>  
> -   $ mkdir -p /usr/local/var/run/ovn
> -   $ ovsdb-server /usr/local/etc/ovn/ovnnb_db.db --remote=punix:/usr/local/var/run/ovn/ovnnb_db.sock \
> +   $ sudo mkdir -p /usr/local/var/run/ovn
> +   $ sudo ovsdb-server /usr/local/etc/ovn/ovnnb_db.db --remote=punix:/usr/local/var/run/ovn/ovnnb_db.sock \
>          --remote=db:OVN_Northbound,NB_Global,connections \
>          --private-key=db:OVN_Northbound,SSL,private_key \
>          --certificate=db:OVN_Northbound,SSL,certificate \
>          --bootstrap-ca-cert=db:OVN_Northbound,SSL,ca_cert \
>          --pidfile=/usr/local/var/run/ovn/ovnnb-server.pid --detach --log-file=/usr/local/var/log/ovn/ovnnb-server.log
> -   $ ovsdb-server /usr/local/etc/ovn/ovnsb_db.db --remote=punix:/usr/local/var/run/ovn/ovnsb_db.sock \
> +   $ sudo ovsdb-server /usr/local/etc/ovn/ovnsb_db.db --remote=punix:/usr/local/var/run/ovn/ovnsb_db.sock \
>          --remote=db:OVN_Southbound,SB_Global,connections \
>          --private-key=db:OVN_Southbound,SSL,private_key \
>          --certificate=db:OVN_Southbound,SSL,certificate \
>
Ben Pfaff April 8, 2021, 3:34 p.m. UTC | #3
On Wed, Apr 07, 2021 at 10:27:25PM +0100, Mark Gray wrote:
> On 07/04/2021 20:43, Aidan Shribman wrote:
> > From: hunchback <aidan.shribman@gmail.com>
> > 
> > add documentation of install sequence sudo to support running install
> > sequence as non-root user
> > 
> > Signed-off-by: Aidan Shribman <aidan.shribman@gmail.com>
> > ---
> >  Documentation/intro/install/general.rst | 14 +++++++-------
> >  1 file changed, 7 insertions(+), 7 deletions(-)
> > 
> > diff --git a/Documentation/intro/install/general.rst b/Documentation/intro/install/general.rst
> > index 08a03a632..ee4827242 100644
> > --- a/Documentation/intro/install/general.rst
> > +++ b/Documentation/intro/install/general.rst
> > @@ -371,7 +371,7 @@ Building
> >  3. Run ``make install`` to install the executables and manpages into the
> >     running system, by default under ``/usr/local``::
> >  
> > -       $ make install
> > +       $ sudo make install
> 
> Maybe the prompt could be changed to "#" to imply root privileges?

It seems to be the "modern" thing to assume people are running as an
unprivileged user but using sudo.  It's what most distros encourage
these days.  It's probably better to go along with it, than to assume
that users know when they need to run as root; the users who know what
they're doing will also know when to skip typing "sudo".
diff mbox series

Patch

diff --git a/Documentation/intro/install/general.rst b/Documentation/intro/install/general.rst
index 08a03a632..ee4827242 100644
--- a/Documentation/intro/install/general.rst
+++ b/Documentation/intro/install/general.rst
@@ -371,7 +371,7 @@  Building
 3. Run ``make install`` to install the executables and manpages into the
    running system, by default under ``/usr/local``::
 
-       $ make install
+       $ sudo make install
 
 .. _general-starting:
 
@@ -422,23 +422,23 @@  Before starting ovn-northd you need to start OVN Northbound and Southbound
 ovsdb-servers. Before ovsdb-servers can be started,
 configure the Northbound and Southbound databases::
 
-       $ mkdir -p /usr/local/etc/ovn
-       $ ovsdb-tool create /usr/local/etc/ovn/ovnnb_db.db \
+       $ sudo mkdir -p /usr/local/etc/ovn
+       $ sudo ovsdb-tool create /usr/local/etc/ovn/ovnnb_db.db \
          ovn-nb.ovsschema
-       $ ovsdb-tool create /usr/local/etc/ovn/ovnsb_db.db \
+       $ sudo ovsdb-tool create /usr/local/etc/ovn/ovnsb_db.db \
          ovn-sb.ovsschema
 
 Configure ovsdb-servers to use databases created above, to listen on a Unix
 domain socket and to use the SSL configuration in the database::
 
-   $ mkdir -p /usr/local/var/run/ovn
-   $ ovsdb-server /usr/local/etc/ovn/ovnnb_db.db --remote=punix:/usr/local/var/run/ovn/ovnnb_db.sock \
+   $ sudo mkdir -p /usr/local/var/run/ovn
+   $ sudo ovsdb-server /usr/local/etc/ovn/ovnnb_db.db --remote=punix:/usr/local/var/run/ovn/ovnnb_db.sock \
         --remote=db:OVN_Northbound,NB_Global,connections \
         --private-key=db:OVN_Northbound,SSL,private_key \
         --certificate=db:OVN_Northbound,SSL,certificate \
         --bootstrap-ca-cert=db:OVN_Northbound,SSL,ca_cert \
         --pidfile=/usr/local/var/run/ovn/ovnnb-server.pid --detach --log-file=/usr/local/var/log/ovn/ovnnb-server.log
-   $ ovsdb-server /usr/local/etc/ovn/ovnsb_db.db --remote=punix:/usr/local/var/run/ovn/ovnsb_db.sock \
+   $ sudo ovsdb-server /usr/local/etc/ovn/ovnsb_db.db --remote=punix:/usr/local/var/run/ovn/ovnsb_db.sock \
         --remote=db:OVN_Southbound,SB_Global,connections \
         --private-key=db:OVN_Southbound,SSL,private_key \
         --certificate=db:OVN_Southbound,SSL,certificate \