diff mbox

[PATCHv4,NETMAP] linux-netmap: Include README in User's Guide

Message ID 1414069834-6658-1-git-send-email-ciprian.barbu@linaro.org
State New
Headers show

Commit Message

Ciprian Barbu Oct. 23, 2014, 1:10 p.m. UTC
Signed-off-by: Ciprian Barbu <ciprian.barbu@linaro.org>
---
v4: rephrasing ./configure part in README

 doc/doxygen.cfg              |  2 +-
 doc/users-guide/guide.dox    |  6 ++----
 platform/linux-netmap/README | 14 +++++++++++++-
 3 files changed, 16 insertions(+), 6 deletions(-)

Comments

Mike Holmes Oct. 24, 2014, 12:37 p.m. UTC | #1
On 23 October 2014 09:10, Ciprian Barbu <ciprian.barbu@linaro.org> wrote:

> Signed-off-by: Ciprian Barbu <ciprian.barbu@linaro.org>
>

Reviewed- and-Tested-by: Mike Holmes <mike.holmes@linaro.org>


> ---
> v4: rephrasing ./configure part in README
>
>  doc/doxygen.cfg              |  2 +-
>  doc/users-guide/guide.dox    |  6 ++----
>  platform/linux-netmap/README | 14 +++++++++++++-
>  3 files changed, 16 insertions(+), 6 deletions(-)
>
> diff --git a/doc/doxygen.cfg b/doc/doxygen.cfg
> index a77ae1e..fc56317 100644
> --- a/doc/doxygen.cfg
> +++ b/doc/doxygen.cfg
> @@ -1,4 +1,4 @@
> -PROJECT_NAME = "API Reference Manual"
> +PROJECT_NAME = "ODP Netmap API Reference Manual"
>  PROJECT_LOGO = $(SRCDIR)/doc/images/ODP-Logo-HQ.png
>  QUIET = YES
>  OUTPUT_DIRECTORY = $(DOCDIR)
> diff --git a/doc/users-guide/guide.dox b/doc/users-guide/guide.dox
> index 314d295..11ec395 100644
> --- a/doc/users-guide/guide.dox
> +++ b/doc/users-guide/guide.dox
> @@ -10,9 +10,7 @@
>   *
>   * @section sec_gene Linux Generic
>   * @verbinclude linux-generic/README
> - * @section sec_dpdk Linux DPDK
> - * @verbinclude linux-dpdk/README
> - * @section sec_keys Linux Keystone2
> - * @verbinclude linux-keystone2/README
> + * @section sec_netm Linux Netmap
> + * @verbinclude linux-netmap/README
>   *
>   */
> diff --git a/platform/linux-netmap/README b/platform/linux-netmap/README
> index 6021445..42b7595 100644
> --- a/platform/linux-netmap/README
> +++ b/platform/linux-netmap/README
> @@ -66,8 +66,20 @@ Now compile netmap:
>  2.2 Building ODP
>  ----------------
>
> +The default platform is linux-netmap, if you want linux-generic you need
> to
> +specify it to configure --with-platform.
> +
> +The --with-sdk-install-path can be used to point to the netmap sources.
> +
>      ./bootstrap
> -    ./configure --with-platform=linux-netmap
> --with-sdk-install-path=<netmap>
> +
> +    ./configure
> +or
> +    ./configure --with-sdk-install-path=<netmap>
> +
> +To configure ODP for linux-generic:
> +    ./configure --with-platform=linux-generic
> +
>      make
>
>  3. Running the example application
> --
> 1.8.3.2
>
>
> _______________________________________________
> lng-odp mailing list
> lng-odp@lists.linaro.org
> http://lists.linaro.org/mailman/listinfo/lng-odp
>
Ciprian Barbu Oct. 27, 2014, 3:36 p.m. UTC | #2
Merged, thank you!

On Fri, Oct 24, 2014 at 3:37 PM, Mike Holmes <mike.holmes@linaro.org> wrote:
>
>
> On 23 October 2014 09:10, Ciprian Barbu <ciprian.barbu@linaro.org> wrote:
>>
>> Signed-off-by: Ciprian Barbu <ciprian.barbu@linaro.org>
>
>
> Reviewed- and-Tested-by: Mike Holmes <mike.holmes@linaro.org>
>
>>
>> ---
>> v4: rephrasing ./configure part in README
>>
>>  doc/doxygen.cfg              |  2 +-
>>  doc/users-guide/guide.dox    |  6 ++----
>>  platform/linux-netmap/README | 14 +++++++++++++-
>>  3 files changed, 16 insertions(+), 6 deletions(-)
>>
>> diff --git a/doc/doxygen.cfg b/doc/doxygen.cfg
>> index a77ae1e..fc56317 100644
>> --- a/doc/doxygen.cfg
>> +++ b/doc/doxygen.cfg
>> @@ -1,4 +1,4 @@
>> -PROJECT_NAME = "API Reference Manual"
>> +PROJECT_NAME = "ODP Netmap API Reference Manual"
>>  PROJECT_LOGO = $(SRCDIR)/doc/images/ODP-Logo-HQ.png
>>  QUIET = YES
>>  OUTPUT_DIRECTORY = $(DOCDIR)
>> diff --git a/doc/users-guide/guide.dox b/doc/users-guide/guide.dox
>> index 314d295..11ec395 100644
>> --- a/doc/users-guide/guide.dox
>> +++ b/doc/users-guide/guide.dox
>> @@ -10,9 +10,7 @@
>>   *
>>   * @section sec_gene Linux Generic
>>   * @verbinclude linux-generic/README
>> - * @section sec_dpdk Linux DPDK
>> - * @verbinclude linux-dpdk/README
>> - * @section sec_keys Linux Keystone2
>> - * @verbinclude linux-keystone2/README
>> + * @section sec_netm Linux Netmap
>> + * @verbinclude linux-netmap/README
>>   *
>>   */
>> diff --git a/platform/linux-netmap/README b/platform/linux-netmap/README
>> index 6021445..42b7595 100644
>> --- a/platform/linux-netmap/README
>> +++ b/platform/linux-netmap/README
>> @@ -66,8 +66,20 @@ Now compile netmap:
>>  2.2 Building ODP
>>  ----------------
>>
>> +The default platform is linux-netmap, if you want linux-generic you need
>> to
>> +specify it to configure --with-platform.
>> +
>> +The --with-sdk-install-path can be used to point to the netmap sources.
>> +
>>      ./bootstrap
>> -    ./configure --with-platform=linux-netmap
>> --with-sdk-install-path=<netmap>
>> +
>> +    ./configure
>> +or
>> +    ./configure --with-sdk-install-path=<netmap>
>> +
>> +To configure ODP for linux-generic:
>> +    ./configure --with-platform=linux-generic
>> +
>>      make
>>
>>  3. Running the example application
>> --
>> 1.8.3.2
>>
>>
>> _______________________________________________
>> lng-odp mailing list
>> lng-odp@lists.linaro.org
>> http://lists.linaro.org/mailman/listinfo/lng-odp
>
>
>
>
> --
> Mike Holmes
> Linaro  Sr Technical Manager
> LNG - ODP
diff mbox

Patch

diff --git a/doc/doxygen.cfg b/doc/doxygen.cfg
index a77ae1e..fc56317 100644
--- a/doc/doxygen.cfg
+++ b/doc/doxygen.cfg
@@ -1,4 +1,4 @@ 
-PROJECT_NAME = "API Reference Manual"
+PROJECT_NAME = "ODP Netmap API Reference Manual"
 PROJECT_LOGO = $(SRCDIR)/doc/images/ODP-Logo-HQ.png
 QUIET = YES
 OUTPUT_DIRECTORY = $(DOCDIR)
diff --git a/doc/users-guide/guide.dox b/doc/users-guide/guide.dox
index 314d295..11ec395 100644
--- a/doc/users-guide/guide.dox
+++ b/doc/users-guide/guide.dox
@@ -10,9 +10,7 @@ 
  *
  * @section sec_gene Linux Generic
  * @verbinclude linux-generic/README
- * @section sec_dpdk Linux DPDK
- * @verbinclude linux-dpdk/README
- * @section sec_keys Linux Keystone2
- * @verbinclude linux-keystone2/README
+ * @section sec_netm Linux Netmap
+ * @verbinclude linux-netmap/README
  *
  */
diff --git a/platform/linux-netmap/README b/platform/linux-netmap/README
index 6021445..42b7595 100644
--- a/platform/linux-netmap/README
+++ b/platform/linux-netmap/README
@@ -66,8 +66,20 @@  Now compile netmap:
 2.2 Building ODP
 ----------------
 
+The default platform is linux-netmap, if you want linux-generic you need to
+specify it to configure --with-platform.
+
+The --with-sdk-install-path can be used to point to the netmap sources.
+
     ./bootstrap
-    ./configure --with-platform=linux-netmap --with-sdk-install-path=<netmap>
+
+    ./configure
+or
+    ./configure --with-sdk-install-path=<netmap>
+
+To configure ODP for linux-generic:
+    ./configure --with-platform=linux-generic
+
     make
 
 3. Running the example application