diff mbox

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

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

Commit Message

Ciprian Barbu Oct. 17, 2014, 1:19 p.m. UTC
Signed-off-by: Ciprian Barbu <ciprian.barbu@linaro.org>
---
 doc/doxygen.cfg           | 2 +-
 doc/users-guide/guide.dox | 8 ++------
 2 files changed, 3 insertions(+), 7 deletions(-)

Comments

Anders Roxell Oct. 17, 2014, 1:55 p.m. UTC | #1
On 2014-10-17 16:19, Ciprian Barbu wrote:
> Signed-off-by: Ciprian Barbu <ciprian.barbu@linaro.org>
> ---
>  doc/doxygen.cfg           | 2 +-
>  doc/users-guide/guide.dox | 8 ++------
>  2 files changed, 3 insertions(+), 7 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..16fecb4 100644
> --- a/doc/users-guide/guide.dox
> +++ b/doc/users-guide/guide.dox
> @@ -8,11 +8,7 @@
>   *
>   * @page users_guide Users Guide
>   *
> - * @section sec_gene Linux Generic
> - * @verbinclude linux-generic/README

Don't remove Linux Generic?
That is in the repository as well.

Cheers,
Anders

> - * @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
>   *
>   */
> -- 
> 1.8.3.2
> 
> 
> _______________________________________________
> lng-odp mailing list
> lng-odp@lists.linaro.org
> http://lists.linaro.org/mailman/listinfo/lng-odp
Mike Holmes Oct. 17, 2014, 1:56 p.m. UTC | #2
On 17 October 2014 09:19, Ciprian Barbu <ciprian.barbu@linaro.org> wrote:

> Signed-off-by: Ciprian Barbu <ciprian.barbu@linaro.org>
> ---
>  doc/doxygen.cfg           | 2 +-
>  doc/users-guide/guide.dox | 8 ++------
>  2 files changed, 3 insertions(+), 7 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..16fecb4 100644
> --- a/doc/users-guide/guide.dox
> +++ b/doc/users-guide/guide.dox
> @@ -8,11 +8,7 @@
>   *
>   * @page users_guide Users Guide
>   *
> - * @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
>

This newly included file included build instructions that may need an
update if the default build patch is applied

On such change is

./configure --with-platform=linux-netmap --with-sdk-install-path=<netmap>

to

./configure --with-sdk-install-path=<netmap>


And you may now need to add a linux-generic instruction specifying how to
build that flavor instead.

>   *
>   */
> --
> 1.8.3.2
>
>
> _______________________________________________
> lng-odp mailing list
> lng-odp@lists.linaro.org
> http://lists.linaro.org/mailman/listinfo/lng-odp
>
Ciprian Barbu Oct. 20, 2014, 12:18 p.m. UTC | #3
On Fri, Oct 17, 2014 at 4:56 PM, Mike Holmes <mike.holmes@linaro.org> wrote:
>
>
> On 17 October 2014 09:19, Ciprian Barbu <ciprian.barbu@linaro.org> wrote:
>>
>> Signed-off-by: Ciprian Barbu <ciprian.barbu@linaro.org>
>> ---
>>  doc/doxygen.cfg           | 2 +-
>>  doc/users-guide/guide.dox | 8 ++------
>>  2 files changed, 3 insertions(+), 7 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..16fecb4 100644
>> --- a/doc/users-guide/guide.dox
>> +++ b/doc/users-guide/guide.dox
>> @@ -8,11 +8,7 @@
>>   *
>>   * @page users_guide Users Guide
>>   *
>> - * @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
>
>
> This newly included file included build instructions that may need an update
> if the default build patch is applied
>
> On such change is
>
> ./configure --with-platform=linux-netmap --with-sdk-install-path=<netmap>
>
> to
>
> ./configure --with-sdk-install-path=<netmap>
>
>
> And you may now need to add a linux-generic instruction specifying how to
> build that flavor instead.

Ok, I will work on this and get a new version out.

>>
>>   *
>>   */
>> --
>> 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..16fecb4 100644
--- a/doc/users-guide/guide.dox
+++ b/doc/users-guide/guide.dox
@@ -8,11 +8,7 @@ 
  *
  * @page users_guide Users Guide
  *
- * @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
  *
  */