diff mbox series

[3/5] travis: catch doxygen errors

Message ID 20170214203202.13342-4-maxim.uvarov@linaro.org
State Accepted
Commit 05f8f96ae606eecfff48e3544885d43b9f541f3c
Headers show
Series various travis updates | expand

Commit Message

Maxim Uvarov Feb. 14, 2017, 8:32 p.m. UTC
make doxygen-doc does not return negative code on
errors. Do it manually.

Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>

---
 .travis.yml | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

-- 
2.11.0.295.gd7dffce

Comments

Mike Holmes Feb. 15, 2017, 5:56 p.m. UTC | #1
On 14 February 2017 at 15:32, Maxim Uvarov <maxim.uvarov@linaro.org> wrote:

> make doxygen-doc does not return negative code on

> errors. Do it manually.

>

> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>

> ---

>  .travis.yml | 4 +++-

>  1 file changed, 3 insertions(+), 1 deletion(-)

>

> diff --git a/.travis.yml b/.travis.yml

> index 9e7471c2..1ab943fe 100644

> --- a/.travis.yml

> +++ b/.travis.yml

> @@ -119,7 +119,9 @@ script:

>

>          - ./bootstrap

>          - ./configure

> -        - make doxygen-doc

> +#        doxygen does not trap on warnings, check for them here.

> +        - make doxygen-doc |tee doxygen.log

> +        - fgrep -rvq warning ./doxygen.log

>


Could Doxygens own error parameter be used to achieve this  transparently ?

WARN_AS_ERROR

If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop
when a warning is encountered.


>          - make distcheck

>

>          - ./bootstrap

> --

> 2.11.0.295.gd7dffce

>

>



-- 
Mike Holmes
Program Manager - Linaro Networking Group
Linaro.org <http://www.linaro.org/> *│ *Open source software for ARM SoCs
"Work should be fun and collaborative, the rest follows"
Maxim Uvarov Feb. 15, 2017, 7:29 p.m. UTC | #2
On 02/15/17 20:56, Mike Holmes wrote:
> 

> 

> On 14 February 2017 at 15:32, Maxim Uvarov <maxim.uvarov@linaro.org

> <mailto:maxim.uvarov@linaro.org>> wrote:

> 

>     make doxygen-doc does not return negative code on

>     errors. Do it manually.

> 

>     Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org

>     <mailto:maxim.uvarov@linaro.org>>

>     ---

>      .travis.yml | 4 +++-

>      1 file changed, 3 insertions(+), 1 deletion(-)

> 

>     diff --git a/.travis.yml b/.travis.yml

>     index 9e7471c2..1ab943fe 100644

>     --- a/.travis.yml

>     +++ b/.travis.yml

>     @@ -119,7 +119,9 @@ script:

> 

>              - ./bootstrap

>              - ./configure

>     -        - make doxygen-doc

>     +#        doxygen does not trap on warnings, check for them here.

>     +        - make doxygen-doc |tee doxygen.log

>     +        - fgrep -rvq warning ./doxygen.log

> 

> 

> Could Doxygens own error parameter be used to achieve this  transparently ?

> 

> |WARN_AS_ERROR|

> 

>     If the |WARN_AS_ERROR| tag is set to |YES| then doxygen will

>     immediately stop when a warning is encountered.

> 

>  


Do you have working version for this option? I tried to do it but might
be it works only with latest doxygen.


Warning: ignoring unsupported tag `WARN_AS_ERROR =' at line 10, file
./doc/Doxyfile_common
22:27 /opt/Linaro/odp3.git (master)$echo $?
0




> 

>              - make distcheck

> 

>              - ./bootstrap

>     --

>     2.11.0.295.gd7dffce

> 

> 

> 

> 

> -- 

> Mike Holmes

> Program Manager - Linaro Networking Group

> Linaro.org <http://www.linaro.org/>* **│ *Open source software for ARM SoCs

> "Work should be fun and collaborative, the rest follows"

> 

> __

> 

>
Mike Holmes Feb. 16, 2017, 1:59 p.m. UTC | #3
On 15 February 2017 at 14:29, Maxim Uvarov <maxim.uvarov@linaro.org> wrote:

> On 02/15/17 20:56, Mike Holmes wrote:

> >

> >

> > On 14 February 2017 at 15:32, Maxim Uvarov <maxim.uvarov@linaro.org

> > <mailto:maxim.uvarov@linaro.org>> wrote:

> >

> >     make doxygen-doc does not return negative code on

> >     errors. Do it manually.

> >

> >     Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org

> >     <mailto:maxim.uvarov@linaro.org>>

> >     ---

> >      .travis.yml | 4 +++-

> >      1 file changed, 3 insertions(+), 1 deletion(-)

> >

> >     diff --git a/.travis.yml b/.travis.yml

> >     index 9e7471c2..1ab943fe 100644

> >     --- a/.travis.yml

> >     +++ b/.travis.yml

> >     @@ -119,7 +119,9 @@ script:

> >

> >              - ./bootstrap

> >              - ./configure

> >     -        - make doxygen-doc

> >     +#        doxygen does not trap on warnings, check for them here.

> >     +        - make doxygen-doc |tee doxygen.log

> >     +        - fgrep -rvq warning ./doxygen.log

> >

> >

> > Could Doxygens own error parameter be used to achieve this

> transparently ?

> >

> > |WARN_AS_ERROR|

> >

> >     If the |WARN_AS_ERROR| tag is set to |YES| then doxygen will

> >     immediately stop when a warning is encountered.

> >

> >

>

> Do you have working version for this option? I tried to do it but might

> be it works only with latest doxygen.

>

>

> Warning: ignoring unsupported tag `WARN_AS_ERROR =' at line 10, file

> ./doc/Doxyfile_common

> 22:27 /opt/Linaro/odp3.git (master)$echo $?

> 0

>

>

>

Could be versions, must be newer - I damaged the docs and it generated this

mike@mike-desktop:~/work/git/odp$ make doxygen-doc
  DXGEN  doc/application-api-guide/Doxyfile
  DXGEN  doc/helper-guide/Doxyfile
  DXGEN  doc/platform-api-guide/Doxyfile
/home/mike/work/git/odp/platform/linux-generic/include/odp/api/plat/byteorder_types.h:53:
error: Member ODP_BIG_ENDIAN (macro definition) of group odp_compiler_optim
is not documented. (warning treated as error, aborting now)
Makefile:947: recipe for target
'doc/platform-api-guide/output/opendataplane.tag' failed
make: *** [doc/platform-api-guide/output/opendataplane.tag] Error 1
mike@mike-desktop:~/work/git/odp$ doxygen --version
1.8.11




>

>

> >

> >              - make distcheck

> >

> >              - ./bootstrap

> >     --

> >     2.11.0.295.gd7dffce

> >

> >

> >

> >

> > --

> > Mike Holmes

> > Program Manager - Linaro Networking Group

> > Linaro.org <http://www.linaro.org/>* **│ *Open source software for ARM

> SoCs

> > "Work should be fun and collaborative, the rest follows"

> >

> > __

> >

> >

>

>



-- 
Mike Holmes
Program Manager - Linaro Networking Group
Linaro.org <http://www.linaro.org/> *│ *Open source software for ARM SoCs
"Work should be fun and collaborative, the rest follows"
Maxim Uvarov Feb. 16, 2017, 2:21 p.m. UTC | #4
On 02/16/17 16:59, Mike Holmes wrote:
> 

> 

> On 15 February 2017 at 14:29, Maxim Uvarov <maxim.uvarov@linaro.org

> <mailto:maxim.uvarov@linaro.org>> wrote:

> 

>     On 02/15/17 20:56, Mike Holmes wrote:

>     >

>     >

>     > On 14 February 2017 at 15:32, Maxim Uvarov <maxim.uvarov@linaro.org <mailto:maxim.uvarov@linaro.org>

>     > <mailto:maxim.uvarov@linaro.org <mailto:maxim.uvarov@linaro.org>>> wrote:

>     >

>     >     make doxygen-doc does not return negative code on

>     >     errors. Do it manually.

>     >

>     >     Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org <mailto:maxim.uvarov@linaro.org>

>     >     <mailto:maxim.uvarov@linaro.org <mailto:maxim.uvarov@linaro.org>>>

>     >     ---

>     >      .travis.yml | 4 +++-

>     >      1 file changed, 3 insertions(+), 1 deletion(-)

>     >

>     >     diff --git a/.travis.yml b/.travis.yml

>     >     index 9e7471c2..1ab943fe 100644

>     >     --- a/.travis.yml

>     >     +++ b/.travis.yml

>     >     @@ -119,7 +119,9 @@ script:

>     >

>     >              - ./bootstrap

>     >              - ./configure

>     >     -        - make doxygen-doc

>     >     +#        doxygen does not trap on warnings, check for them here.

>     >     +        - make doxygen-doc |tee doxygen.log

>     >     +        - fgrep -rvq warning ./doxygen.log

>     >

>     >

>     > Could Doxygens own error parameter be used to achieve this  transparently ?

>     >

>     > |WARN_AS_ERROR|

>     >

>     >     If the |WARN_AS_ERROR| tag is set to |YES| then doxygen will

>     >     immediately stop when a warning is encountered.

>     >

>     >

> 

>     Do you have working version for this option? I tried to do it but might

>     be it works only with latest doxygen.

> 

> 

>     Warning: ignoring unsupported tag `WARN_AS_ERROR =' at line 10, file

>     ./doc/Doxyfile_common

>     22:27 /opt/Linaro/odp3.git (master)$echo $?

>     0

> 

> 

> 

> Could be versions, must be newer - I damaged the docs and it generated this

> 

> mike@mike-desktop:~/work/git/odp$ make doxygen-doc 

>   DXGEN  doc/application-api-guide/Doxyfile

>   DXGEN  doc/helper-guide/Doxyfile

>   DXGEN  doc/platform-api-guide/Doxyfile

> /home/mike/work/git/odp/platform/linux-generic/include/odp/api/plat/byteorder_types.h:53:

> error: Member ODP_BIG_ENDIAN (macro definition) of group

> odp_compiler_optim is not documented. (warning treated as error,

> aborting now)

> Makefile:947: recipe for target

> 'doc/platform-api-guide/output/opendataplane.tag' failed

> make: *** [doc/platform-api-guide/output/opendataplane.tag] Error 1

> mike@mike-desktop:~/work/git/odp$ doxygen --version

> 1.8.11

> 

> 


1.8.6


>  

> 

> 

> 

>     >

>     >              - make distcheck

>     >

>     >              - ./bootstrap

>     >     --

>     >     2.11.0.295.gd7dffce

>     >

>     >

>     >

>     >

>     > --

>     > Mike Holmes

>     > Program Manager - Linaro Networking Group

>     > Linaro.org <http://www.linaro.org/>* **│ *Open source software for

>     ARM SoCs

>     > "Work should be fun and collaborative, the rest follows"

>     >

>     > __

>     >

>     >

> 

> 

> 

> 

> -- 

> Mike Holmes

> Program Manager - Linaro Networking Group

> Linaro.org <http://www.linaro.org/>* **│ *Open source software for ARM SoCs

> "Work should be fun and collaborative, the rest follows"

> 

> __

> 

>
Mike Holmes Feb. 17, 2017, 1:36 p.m. UTC | #5
On 14 February 2017 at 15:32, Maxim Uvarov <maxim.uvarov@linaro.org> wrote:

> make doxygen-doc does not return negative code on

> errors. Do it manually.

>

> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>

>


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



> ---

>  .travis.yml | 4 +++-

>  1 file changed, 3 insertions(+), 1 deletion(-)

>

> diff --git a/.travis.yml b/.travis.yml

> index 9e7471c2..1ab943fe 100644

> --- a/.travis.yml

> +++ b/.travis.yml

> @@ -119,7 +119,9 @@ script:

>

>          - ./bootstrap

>          - ./configure

> -        - make doxygen-doc

> +#        doxygen does not trap on warnings, check for them here.

> +        - make doxygen-doc |tee doxygen.log

> +        - fgrep -rvq warning ./doxygen.log

>          - make distcheck

>

>          - ./bootstrap

> --

> 2.11.0.295.gd7dffce

>

>



-- 
Mike Holmes
Program Manager - Linaro Networking Group
Linaro.org <http://www.linaro.org/> *│ *Open source software for ARM SoCs
"Work should be fun and collaborative, the rest follows"
diff mbox series

Patch

diff --git a/.travis.yml b/.travis.yml
index 9e7471c2..1ab943fe 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -119,7 +119,9 @@  script:
 
         - ./bootstrap
         - ./configure
-        - make doxygen-doc
+#        doxygen does not trap on warnings, check for them here.
+        - make doxygen-doc |tee doxygen.log
+        - fgrep -rvq warning ./doxygen.log
         - make distcheck
 
         - ./bootstrap