[inspect] Changes to Inspection Report

The latest run of the trunk inspection report is up at http://boost.cowic.de/rc/inspect-trunk.html Several new features have been added: * References to unknown bookmarks are now detected. * Duplicate bookmarks are now detected. * Each problem detected is reported on a separate line, to make it easier to work with files that have multiple problems. For example, see the errors below in the filesystem library. Comments? --Beman filesystem libs/filesystem/doc/faq.htm: *LINK* unknown bookmark: #global libs/filesystem/doc/i18n.html: *LINK* unknown bookmark: #Footnote *LINK* unknown bookmark: #status libs/filesystem/doc/index.htm: *LINK* unknown bookmark: #path libs/filesystem/doc/reference.html: *LINK* duplicate bookmark: exists *LINK* duplicate bookmark: initial_path *LINK* unknown bookmark: #basic_directory_entry-comparisons *LINK* unknown bookmark: #operator-eq libs/filesystem/test/deprecated_test.cpp: *APPLE-MACROS* violation of Boost apple-macro guidelines on line 21 *APPLE-MACROS* violation of Boost apple-macro guidelines on line 27 libs/filesystem/test/path_test.cpp: *APPLE-MACROS* violation of Boost apple-macro guidelines on line 34 *APPLE-MACROS* violation of Boost apple-macro guidelines on line 43

On Mon, Jan 18, 2010 at 6:02 PM, Beman Dawes <bdawes@acm.org> wrote:
The latest run of the trunk inspection report is up at http://boost.cowic.de/rc/inspect-trunk.html
Comments?
If you want it to be easy to grep for filesystem or for use in Emacs, I think you should prefix every line with the file name, I.e.: libs/filesystem/doc/faq.htm: *LINK* unknown bookmark: #global libs/filesystem/doc/i18n.html: *LINK* unknown bookmark: #Footnote libs/filesystem/doc/i18n.html: *LINK* unknown bookmark: #status libs/filesystem/test/deprecated_test.cpp:21: *APPLE-MACROS* violation of Boost apple-macro guidelines Syntax: file[:<line>[:<column>]]: <error text> /$

Henrik Sundberg wrote:
On Mon, Jan 18, 2010 at 6:02 PM, Beman Dawes <bdawes@acm.org> wrote:
The latest run of the trunk inspection report is up at http://boost.cowic.de/rc/inspect-trunk.html
Comments?
If you want it to be easy to grep for filesystem or for use in Emacs, I think you should prefix every line with the file name, I.e.:
libs/filesystem/doc/faq.htm: *LINK* unknown bookmark: #global libs/filesystem/doc/i18n.html: *LINK* unknown bookmark: #Footnote libs/filesystem/doc/i18n.html: *LINK* unknown bookmark: #status
libs/filesystem/test/deprecated_test.cpp:21: *APPLE-MACROS* violation of Boost apple-macro guidelines
Syntax: file[:<line>[:<column>]]: <error text>
We used to do that, once upon a long time. But it made the output so long that we could not post it as email, browsers would time out downloading and displaying it, and browsers would crash trying to generate the display page for it. We don't email it any more so that's no an issue, but the others might still be. -- -- Grafik - Don't Assume Anything -- Redshift Software, Inc. - http://redshift-software.com -- rrivera/acm.org (msn) - grafik/redshift-software.com -- 102708583/icq - grafikrobot/aim,yahoo,skype,efnet,gmail

On Mon, Jan 18, 2010 at 12:25 PM, Rene Rivera <grafikrobot@gmail.com> wrote:
Henrik Sundberg wrote:
On Mon, Jan 18, 2010 at 6:02 PM, Beman Dawes <bdawes@acm.org> wrote:
The latest run of the trunk inspection report is up at http://boost.cowic.de/rc/inspect-trunk.html
Comments?
If you want it to be easy to grep for filesystem or for use in Emacs, I think you should prefix every line with the file name, I.e.:
libs/filesystem/doc/faq.htm: *LINK* unknown bookmark: #global libs/filesystem/doc/i18n.html: *LINK* unknown bookmark: #Footnote libs/filesystem/doc/i18n.html: *LINK* unknown bookmark: #status
libs/filesystem/test/deprecated_test.cpp:21: *APPLE-MACROS* violation of Boost apple-macro guidelines
Syntax: file[:<line>[:<column>]]: <error text>
We used to do that, once upon a long time. But it made the output so long that we could not post it as email, browsers would time out downloading and displaying it, and browsers would crash trying to generate the display page for it. We don't email it any more so that's no an issue, but the others might still be.
I think those are still reasonable concerns. Also, since the summary section contains a link to the problems for a particular library, I'm not as worried about grep-ability as I would be if the output were unsorted. --Beman

The latest run of the trunk inspection report is up at http://boost.cowic.de/rc/inspect-trunk.html
Several new features have been added:
* References to unknown bookmarks are now detected. * Duplicate bookmarks are now detected. * Each problem detected is reported on a separate line, to make it easier to work with files that have multiple problems.
For example, see the errors below in the filesystem library.
Comments?
Where can I find the docs for the apple-macro guidelines (causing this: *APPLE-MACROS* violation of Boost apple-macro guidelines)? Regards Hartmut --------------- Meet me at BoostCon www.boostcon.com

On Jan 18, 2010, at 9:23 AM, Hartmut Kaiser wrote:
The latest run of the trunk inspection report is up at http://boost.cowic.de/rc/inspect-trunk.html
Several new features have been added:
* References to unknown bookmarks are now detected. * Duplicate bookmarks are now detected. * Each problem detected is reported on a separate line, to make it easier to work with files that have multiple problems.
For example, see the errors below in the filesystem library.
Comments?
Where can I find the docs for the apple-macro guidelines (causing this: *APPLE-MACROS* violation of Boost apple-macro guidelines)?
Right now - bug #2115 :-( <https://svn.boost.org/trac/boost/ticket/2115> I've got "updating the guidelines for Apple Macros" on my to-do list. -- Marshall

On Mon, Jan 18, 2010 at 12:28 PM, Marshall Clow <mclow.lists@gmail.com> wrote:
On Jan 18, 2010, at 9:23 AM, Hartmut Kaiser wrote:
The latest run of the trunk inspection report is up at http://boost.cowic.de/rc/inspect-trunk.html
Several new features have been added:
* References to unknown bookmarks are now detected. * Duplicate bookmarks are now detected. * Each problem detected is reported on a separate line, to make it easier to work with files that have multiple problems.
For example, see the errors below in the filesystem library.
Comments?
Where can I find the docs for the apple-macro guidelines (causing this: *APPLE-MACROS* violation of Boost apple-macro guidelines)?
Right now - bug #2115 :-( <https://svn.boost.org/trac/boost/ticket/2115>
I've got "updating the guidelines for Apple Macros" on my to-do list.
I'm still against pressuring developers to avoid those macros, and think we should not report them as part of the normal inspection report. In other words, make the default to be not to run that particular check. --Beman

Hi, ----- Original Message ----- From: "Beman Dawes" <bdawes@acm.org> To: "Boost Developers List" <boost@lists.boost.org> Sent: Monday, January 18, 2010 6:02 PM Subject: [boost] [inspect] Changes to Inspection Report The latest run of the trunk inspection report is up at http://boost.cowic.de/rc/inspect-trunk.html Several new features have been added: * References to unknown bookmarks are now detected. * Duplicate bookmarks are now detected. * Each problem detected is reported on a separate line, to make it easier to work with files that have multiple problems. For example, see the errors below in the filesystem library. Comments? --Beman filesystem libs/filesystem/test/deprecated_test.cpp: *APPLE-MACROS* violation of Boost apple-macro guidelines on line 21 *APPLE-MACROS* violation of Boost apple-macro guidelines on line 27 libs/filesystem/test/path_test.cpp: *APPLE-MACROS* violation of Boost apple-macro guidelines on line 34 *APPLE-MACROS* violation of Boost apple-macro guidelines on line 43 _______________________________________________ Unsubscribe & other changes: http://lists.boost.org/mailman/listinfo.cgi/boost What does *APPLE-MACROS* violation of Boost apple-macro guidelines on line 34 mean? Vicente

On Mon, 18 Jan 2010, Beman Dawes wrote:
The latest run of the trunk inspection report is up at http://boost.cowic.de/rc/inspect-trunk.html
Several new features have been added:
* References to unknown bookmarks are now detected. * Duplicate bookmarks are now detected. * Each problem detected is reported on a separate line, to make it easier to work with files that have multiple problems.
For example, see the errors below in the filesystem library.
Comments?
One little thing I noticed is that the sorting of error locations is a text sort, not a numeric sort by line number. For example, look at the list of *APPLE-MACROS* warnings for libs/asio/test/write_at.cpp: the first warning is for line 1005, and line 145 shows up later. Also, is it possible to get line numbers for duplicate bookmarks and references to unknown bookmarks? -- Jeremiah Willcock

On Mon, Jan 18, 2010 at 1:06 PM, Jeremiah Willcock <jewillco@osl.iu.edu> wrote:
On Mon, 18 Jan 2010, Beman Dawes wrote:
The latest run of the trunk inspection report is up at http://boost.cowic.de/rc/inspect-trunk.html
Several new features have been added:
* References to unknown bookmarks are now detected. * Duplicate bookmarks are now detected. * Each problem detected is reported on a separate line, to make it easier to work with files that have multiple problems.
For example, see the errors below in the filesystem library.
Comments?
One little thing I noticed is that the sorting of error locations is a text sort, not a numeric sort by line number. For example, look at the list of *APPLE-MACROS* warnings for libs/asio/test/write_at.cpp: the first warning is for line 1005, and line 145 shows up later. Also, is it possible to get line numbers for duplicate bookmarks and references to unknown bookmarks?
Good points. Looks doable. I'll give it a try. Thanks, --Beman

On Mon, Jan 18, 2010 at 2:32 PM, Daniel James <daniel_james@fmail.co.uk> wrote:
2010/1/18 Beman Dawes <bdawes@acm.org>:
* References to unknown bookmarks are now detected.
Thanks, it looks good. I've tweaked it a little on trunk as there are some false positives for Boost.Test and Boost.Rational.
Thanks! Much appreciated, --Beman
participants (8)
-
Beman Dawes
-
Daniel James
-
Hartmut Kaiser
-
Henrik Sundberg
-
Jeremiah Willcock
-
Marshall Clow
-
Rene Rivera
-
vicente.botet