diff options
author | Nathan Skrzypczak <nathan.skrzypczak@gmail.com> | 2021-08-19 11:38:06 +0200 |
---|---|---|
committer | Dave Wallace <dwallacelf@gmail.com> | 2021-10-13 23:22:32 +0000 |
commit | 9ad39c026c8a3c945a7003c4aa4f5cb1d4c80160 (patch) | |
tree | 3cca19635417e28ae381d67ae31c75df2925032d /docs/reference/vppvagrant/settingENV.rst | |
parent | f47122e07e1ecd0151902a3cabe46c60a99bee8e (diff) |
docs: better docs, mv doxygen to sphinx
This patch refactors the VPP sphinx docs
in order to make it easier to consume
for external readers as well as VPP developers.
It also makes sphinx the single source
of documentation, which simplifies maintenance
and operation.
Most important updates are:
- reformat the existing documentation as rst
- split RELEASE.md and move it into separate rst files
- remove section 'events'
- remove section 'archive'
- remove section 'related projects'
- remove section 'feature by release'
- remove section 'Various links'
- make (Configuration reference, CLI docs,
developer docs) top level items in the list
- move 'Use Cases' as part of 'About VPP'
- move 'Troubleshooting' as part of 'Getting Started'
- move test framework docs into 'Developer Documentation'
- add a 'Contributing' section for gerrit,
docs and other contributer related infos
- deprecate doxygen and test-docs targets
- redirect the "make doxygen" target to "make docs"
Type: refactor
Change-Id: I552a5645d5b7964d547f99b1336e2ac24e7c209f
Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
Signed-off-by: Andrew Yourtchenko <ayourtch@gmail.com>
Diffstat (limited to 'docs/reference/vppvagrant/settingENV.rst')
-rw-r--r-- | docs/reference/vppvagrant/settingENV.rst | 29 |
1 files changed, 0 insertions, 29 deletions
diff --git a/docs/reference/vppvagrant/settingENV.rst b/docs/reference/vppvagrant/settingENV.rst deleted file mode 100644 index 8bd7847d36c..00000000000 --- a/docs/reference/vppvagrant/settingENV.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. _settingENV: - -.. toctree:: - - -Setting your ENV Variables -========================== - - -The :ref:`vppVagrantfile` used in the VPP repo sets the configuration options based on your ENV (environment) variables, or to default the configuration at specified values if your ENV variables are not initialized (if you did not run the *env.sh* script found below). - -This is the *env.sh* script found in *vpp/extras/vagrant*. When run, the script sets ENV variables using the **export** command. - -.. code-block:: bash - - export VPP_VAGRANT_DISTRO="ubuntu1604" - export VPP_VAGRANT_NICS=2 - export VPP_VAGRANT_VMCPU=4 - export VPP_VAGRANT_VMRAM=4096 - -In the :ref:`vppVagrantfile`, you can see these same ENV variables used (discussed on the next page). - -Adding your own ENV variables is easy. For example, if you wanted to setup proxies for your VM, you would add to this file the **export** commands found in the :ref:`building VPP commands section <building>`. Note that this only works if the ENV variable is defined in the :ref:`vppVagrantfile`. - -Once you're finished with *env.sh* script, and you are in the directory containing *env.sh*, run the script to set the ENV variables with: - -.. code-block:: shell - - $ source ./env.sh |