summaryrefslogtreecommitdiffstats
path: root/release-notes/src/main/asciidoc/install_guide
diff options
context:
space:
mode:
authorMarek Gradzki <mgradzki@cisco.com>2017-01-30 11:34:22 +0100
committerJan Srnicek <jsrnicek@cisco.com>2017-02-23 06:36:52 +0000
commit27922cc77498479eabe58cf82647b31aa880a0cc (patch)
tree8746f0d831917f534b765398c72e912cca72220b /release-notes/src/main/asciidoc/install_guide
parentec441a2601397ae0738152615860a8f011dd16c4 (diff)
Release notes post 17.01 cleanup
Based on https://gerrit.fd.io/r/#/c/4937/ Change-Id: I96afecd077bf9ba4de1f684c251944de3e457e86 Signed-off-by: Marek Gradzki <mgradzki@cisco.com>
Diffstat (limited to 'release-notes/src/main/asciidoc/install_guide')
-rw-r--r--release-notes/src/main/asciidoc/install_guide/install_from_available_archives.adoc4
-rw-r--r--release-notes/src/main/asciidoc/install_guide/install_manual_build.adoc24
2 files changed, 14 insertions, 14 deletions
diff --git a/release-notes/src/main/asciidoc/install_guide/install_from_available_archives.adoc b/release-notes/src/main/asciidoc/install_guide/install_from_available_archives.adoc
index 5eeb4fee2..6060c309f 100644
--- a/release-notes/src/main/asciidoc/install_guide/install_from_available_archives.adoc
+++ b/release-notes/src/main/asciidoc/install_guide/install_from_available_archives.adoc
@@ -2,10 +2,10 @@
link:release_notes.html[< Home]
-Honeycomb provides zip and tar.gz archives that can be downloaded and extracted to provide Honeycomb VPP distribution.
+Hc2vpp provides zip and tar.gz archives that can be downloaded and extracted to provide Honeycomb VPP distribution.
== Downloading archives
-In https://nexus.fd.io/#nexus-search;quick~vpp-integration-distribution[Honeycomb's nexus] look for vpp-integration-distribution artifact with version {project-version} and download either zip or tar.gz. After Extracting the archive, a folder vpp-integration-distribution-<version> will be created.
+In https://nexus.fd.io/#nexus-search;quick~vpp-integration-distribution[fdio's nexus] look for vpp-integration-distribution artifact with version {project-version} and download either zip or tar.gz. After extracting the archive, a folder vpp-integration-distribution-{project-version} will be created.
== Running extracted distribution[edit]
In the new folder, locate honeycomb executable shell script and run it.
diff --git a/release-notes/src/main/asciidoc/install_guide/install_manual_build.adoc b/release-notes/src/main/asciidoc/install_guide/install_manual_build.adoc
index 82ab84413..59a9f3122 100644
--- a/release-notes/src/main/asciidoc/install_guide/install_manual_build.adoc
+++ b/release-notes/src/main/asciidoc/install_guide/install_manual_build.adoc
@@ -3,24 +3,24 @@
link:release_notes.html[< Home]
== Prerequisites
-Building Honeycomb project requires:
+Building Hc2vpp project requires:
* Java 8
* Maven (version 3.2.5 and above should be fine)
* Properly set maven settings(displayed below) to access nexus.fd.io
-== Obtain the honeycomb source code
+== Obtain the hc2vpp source code
TIP: Make sure you have https://wiki.fd.io/view/DEV/Setting_up_Gerrit[registered your ssh key with gerrit].
[subs="+attributes"]
- git clone ssh://[username]@gerrit.fd.io:29418/honeycomb
- cd honeycomb
+ git clone ssh://[username]@gerrit.fd.io:29418/hc2vpp
+ cd hc2vpp
git checkout {project-branch}
== Building the code
Make sure all the prerequisites are installed.
-NOTE: To make sure fresh Honeycomb build is compatible with VPP, building VPP is also required to make sure the same JVpp version is used preventing out-of-sync exceptions. In case only Honeycomb needs to be built, skip Building VPP section.
+NOTE: To make sure fresh hc2vpp build is compatible with VPP, building VPP is also required to make sure the same JVpp version is used preventing out-of-sync exceptions. In case only hc2vpp needs to be built, skip Building VPP section.
=== Building VPP
Clone VPP according to: https://gerrit.fd.io/r/#/admin/projects/vpp and checkout {project-branch} branch
@@ -41,7 +41,7 @@ Start VPP:
sudo start vpp
-Install JVpp into local maven repository to make Honeycomb pick up the same JVpp version
+Install JVpp into local maven repository to make hc2vpp pick up the same JVpp version
[subs="+attributes"]
cd build-vpp-native/vpp-api/java/
@@ -52,8 +52,8 @@ Install JVpp into local maven repository to make Honeycomb pick up the same JVpp
Now current Vpp is up and running and prepared for integration with HC.
-=== Building Honeycomb
-Now Honeycomb can be built and it will use latest JVpp produced during VPP build.
+=== Building hc2vpp
+Now hc2vpp can be built and it will use latest JVpp produced during VPP build.
==== Setup settings.xml
Put the following in your ~/.m2/settings.xml:
@@ -167,8 +167,8 @@ Put the following in your ~/.m2/settings.xml:
</settings>
----
-==== Building Honeycomb
-cd honeycomb/
+==== Building hc2vpp
+cd hc2vpp/
mvn clean install
@@ -179,13 +179,13 @@ To perform quick build(no tests, no checks, no docs) run:
mvn clean install -DskipTests -Dcheckstyle.skip -Dmaven.javadoc.skip=true -Djacoco.skip
=====
-Now Honeycomb can be run with:
+Now hc2vpp can be run with:
[subs="+attributes"]
sudo sh vpp-integration/minimal-distribution/target/vpp-integration-distribution-{project-version}-hc/vpp-integration-distribution-{project-version}/honeycomb
=== Building packages
-After the code has been built, you can build an RPM or DEB package for honeycomb.
+After the code has been built, you can build an RPM or DEB package for hc2vpp.
==== RPM
Export build number variable: