Minor corrections in documentation

ygorelik · Dec 19, 2018 · cda842d · cda842d
1 parent 6475f80
commit cda842d
Show file tree

Hide file tree

Showing 8 changed files with 19 additions and 65 deletions.
diff --git a/README.md b/README.md
@@ -86,6 +86,11 @@ Please follow the below instructions to install the system requirements before i
 ```
    $ sudo apt-get install gdebi-core python3-dev python-dev libtool-bin
    $ sudo apt-get install libcurl4-openssl-dev libpcre3-dev libssh-dev libxml2-dev libxslt1-dev libtool-bin cmake
+
+   $ # Upgrade compiler to gcc 5.*
+   $ sudo apt-get install gcc-5 g++-5 -y > /dev/null
+   $ sudo ln -sf /usr/bin/g++-5 /usr/bin/c++
+   $ sudo ln -sf /usr/bin/gcc-5 /usr/bin/cc
 ```
 
 #### Install libydk library
@@ -117,8 +122,8 @@ $ sudo gdebi libydk_0.8.0-1_amd64.deb
    # Upgrade compiler to gcc 5.*
    $ sudo yum install centos-release-scl -y > /dev/null
    $ sudo yum install devtoolset-4-gcc* -y > /dev/null
-   $ sudo ln -s -f /opt/r h/devtoolset-4/root/usr/bin/gcc /usr/bin/cc
-   $ sudo ln -s -f /opt/rh/devtoolset-4/root/usr/bin/g++ /usr/bin/c++
+   $ sudo ln -sf /opt/r h/devtoolset-4/root/usr/bin/gcc /usr/bin/cc
+   $ sudo ln -sf /opt/rh/devtoolset-4/root/usr/bin/g++ /usr/bin/c++
 ```
 
 #### Install prebuilt libydk binary
@@ -211,7 +216,6 @@ In order to enable YDK support for gNMI protocol, which is optional, the followi
     cd protobuf-3.5.0
     ./configure
     make
-    make check
     sudo make install
     sudo ldconfig
 ```

diff --git a/sdk/cpp/README.md b/sdk/cpp/README.md
@@ -96,7 +96,6 @@ In order to enable YDK support for gNMI protocol, which is optional, the followi
     cd protobuf-3.5.0
     ./configure
     make
-    make check
     sudo make install
     sudo ldconfig
 ```

diff --git a/sdk/cpp/core/docsgen/getting_started.rst b/sdk/cpp/core/docsgen/getting_started.rst
@@ -31,8 +31,6 @@ The following packages must be present in your system before installing YDK-Cpp:
    sudo apt-get install libcurl4-openssl-dev libpcre3-dev libssh-dev libxml2-dev libxslt1-dev libtool-bin cmake
    #
    # gcc-5 and g++5 for modern c++
-   sudo add-apt-repository ppa:ubuntu-toolchain-r/test -y
-   sudo apt-get update > /dev/null
    sudo apt-get install gcc-5 g++-5 -y > /dev/null
    sudo ln -f -s /usr/bin/g++-5 /usr/bin/c++
    sudo ln -f -s /usr/bin/gcc-5 /usr/bin/cc
@@ -80,7 +78,6 @@ In order to enable YDK support for gNMI protocol, which is optional, the followi
     cd protobuf-3.5.0
     ./configure
     make
-    make check
     sudo make install
     sudo ldconfig
     cd -
@@ -97,17 +94,6 @@ In order to enable YDK support for gNMI protocol, which is optional, the followi
     sudo ldconfig
     cd -
 
-**Set LD_LIBRARY_PATH**
-
-The YDK based application runtime environment must include setting of **LD_LIBRARY_PATH** variable:
-
-.. code-block:: sh
-
-    PROTO="/Your-Protobuf-and-Grpc-installation-directory"
-    export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$PROTO/grpc/libs/opt:$PROTO/protobuf-3.5.0/src/.libs:/usr/local/lib64
-
-**Note:** There is an open issue with gRPC on Centos/Fedora, which requires an extra step before running any YDK gNMI application. See this issue on `GRPC GitHub <https://github.com/grpc/grpc/issues/10942#issuecomment-312565041>`_ for details.
-
 Quick YDK Installation
 ----------------------
 
@@ -179,40 +165,13 @@ If you want to install only the ``ietf`` bundle and its dependencies (``ydk`` pa
 
   brew install ydk-ietf
 
-gNMI Requirements
-===================
-
-In order to have YDK support for gNMI protocol, which is optional, the following third party software must be installed prior to gNMI YDK component installation.
-
-**Install protobuf**
-
-.. code-block:: sh
-
-    wget https://github.com/google/protobuf/releases/download/v3.5.0/protobuf-cpp-3.5.0.zip
-    unzip protobuf-cpp-3.5.0.zip
-    cd protobuf-3.5.0
-    ./configure
-    make
-    make check
-    sudo make install
-    sudo ldconfig
-    cd -
-
-**Install gRPC**
+gNMI Service Installation
+-------------------------
 
-.. code-block:: sh
+Instal YDK gNMI library
+~~~~~~~~~~~~~~~~~~~~~~~
 
-    git clone -b v1.9.1 https://github.com/grpc/grpc
-    cd grpc
-    git submodule update --init
-    sudo ldconfig
-    make
-    sudo make install
-    cd -
-
-**Instal YDK gNMI library**
-
-Ubuntu
+**Ubuntu**
 
 For Xenial (Ubuntu 16.04.4):
 
@@ -228,13 +187,14 @@ For Bionic (Ubuntu 18.04.1):
    wget https://devhub.cisco.com/artifactory/debian-ydk/0.8.0/bionic/libydk_gnmi_0.4.0-1_amd64.deb
    sudo gdebi libydk_gnmi_0.4.0-1_amd64.deb
 
-CentOS
+**CentOS**
 
 .. code-block:: sh
 
    sudo yum install https://devhub.cisco.com/artifactory/rpm-ydk/0.8.0/libydk_gnmi_0.4.0-1.x86_64.rpm
 
-**Set runtime environment**
+Set runtime environment
+~~~~~~~~~~~~~~~~~~~~~~~
 
 The YDK based application runtime environment must include setting of **LD_LIBRARY_PATH** variable:
 

diff --git a/sdk/go/README.md b/sdk/go/README.md
@@ -49,8 +49,6 @@ Install third-party dependency software:
 $ sudo apt-get install libcurl4-openssl-dev libpcre3-dev libssh-dev libxml2-dev libxslt1-dev libtool-bin cmake
 
 # Install gcc-5 and g++-5
-sudo add-apt-repository ppa:ubuntu-toolchain-r/test -y
-sudo apt-get update > /dev/null
 sudo apt-get install gcc-5 g++-5 -y > /dev/null
 sudo ln -f -s /usr/bin/g++-5 /usr/bin/c++
 sudo ln -f -s /usr/bin/gcc-5 /usr/bin/cc
@@ -153,7 +151,6 @@ In order to enable YDK support for gNMI protocol, which is optional, the followi
     cd protobuf-3.5.0
     ./configure
     make
-    make check
     sudo make install
     sudo ldconfig
 ```

diff --git a/sdk/go/core/README.md b/sdk/go/core/README.md
@@ -44,7 +44,6 @@ In order to enable YDK support for gNMI protocol, which is optional, the followi
     cd protobuf-3.5.0
     ./configure
     make
-    make check
     sudo make install
     sudo ldconfig
 ```

diff --git a/sdk/go/core/docsgen/getting_started.rst b/sdk/go/core/docsgen/getting_started.rst
@@ -100,7 +100,6 @@ In order to have YDK support for gNMI protocol, which is optional, the following
     cd protobuf-3.5.0
     ./configure
     make
-    make check
     sudo make install
     sudo ldconfig
     cd -

diff --git a/sdk/python/README.rst b/sdk/python/README.rst
@@ -45,8 +45,6 @@ Linux
 
 The following packages must be present in your system before installing YDK-Py::
 
-   $ sudo apt-get update > /dev/null
-   $ sudo add-apt-repository ppa:ubuntu-toolchain-r/test -y
    $ sudo apt-get install gdebi-core python3-dev python-dev libtool-bin  
    
    # Upgrade compiler to gcc 5.*
@@ -125,7 +123,6 @@ Install protobuf and protoc
     $ cd protobuf-3.5.0
     $ ./configure
     $ make
-    $ make check
     $ sudo make install
     $ sudo ldconfig
 

diff --git a/sdk/python/core/docsgen/getting_started.rst b/sdk/python/core/docsgen/getting_started.rst
@@ -108,12 +108,11 @@ Install protobuf
 
 .. code-block:: sh
 
-    wget https://github.com/google/protobuf/releases/download/v3.3.0/protobuf-cpp-3.3.0.zip
-    unzip protobuf-cpp-3.3.0.zip
-    cd protobuf-3.3.0
+    wget https://github.com/google/protobuf/releases/download/v3.5.0/protobuf-cpp-3.5.0.zip
+    unzip protobuf-cpp-3.5.0.zip
+    cd protobuf-3.5.0
     ./configure
     make
-    make check
     sudo make install
     sudo ldconfig
 
@@ -122,7 +121,7 @@ Install gRPC
 
 .. code-block:: sh
 
-    git clone -b v1.4.5 https://github.com/grpc/grpc
+    git clone -b v1.9.1 https://github.com/grpc/grpc
     cd grpc
     git submodule update --init
     sudo ldconfig