Details

    • Type: Task Task
    • Status: Closed
    • Priority: Blocker Blocker
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 4.2.0
    • Component/s: Release
    • Labels:
      None

      Description

      As Bill says in his post below, we need to run the RAT tool on stdcxx 4.2.0 before we ask the Incubator PMC for a permission to do a release:

      http://www.mail-archive.com/stdcxx-dev@incubator.apache.org/msg03858.html

      The first step will be to download and set up the tool. In this post Justin gives some suggestions:
      http://www.mail-archive.com/stdcxx-dev@incubator.apache.org/msg03764.html

      Here are a couple of links to other Apache projects that use it. They could be helpful in getting it up and running:
      http://www.mail-archive.com/stdcxx-dev@incubator.apache.org/msg03865.html

        Issue Links

        There are no Sub-Tasks for this issue.

          Activity

          Hide
          Martin Sebor added a comment -

          The "old" ASL header should be updated but (as I mention below) since RAT doesn't complain it's not a blocker for 4.2.0.
          http://www.nabble.com/RE%3A--VOTE-RESULT--release-stdcxx-4.2.0-%28candidate-7%29-p13431011.html
          Let's keep this closed.

          Show
          Martin Sebor added a comment - The "old" ASL header should be updated but (as I mention below) since RAT doesn't complain it's not a blocker for 4.2.0. http://www.nabble.com/RE%3A--VOTE-RESULT--release-stdcxx-4.2.0-%28candidate-7%29-p13431011.html Let's keep this closed.
          Hide
          Farid Zaripov added a comment -

          Attached grep.out file.

          Show
          Farid Zaripov added a comment - Attached grep.out file.
          Hide
          Farid Zaripov added a comment -

          It seems, that 75 files in stdcxx-4.2.0-rc-7 are contains the previous ASL header:

          $ grep -r "Licensed under" /usr/src/stdcxx-4.2.0-rc-7/* >grep.out

          See the attached grep.out file.

          Show
          Farid Zaripov added a comment - It seems, that 75 files in stdcxx-4.2.0-rc-7 are contains the previous ASL header: $ grep -r "Licensed under" /usr/src/stdcxx-4.2.0-rc-7/* >grep.out See the attached grep.out file.
          Hide
          Martin Sebor added a comment -

          Thanks, Travis. I think we can consider the issue fully resolved. Closing as Fixed.

          Show
          Martin Sebor added a comment - Thanks, Travis. I think we can consider the issue fully resolved. Closing as Fixed.
          Hide
          Travis Vitek added a comment - - edited

          The code that reads the gen_list file doesn't appear to process comments. I couldn't actually find anything that referenced the codeset_aliases file, so it may be garbage left behind [the code in aliases.cpp used by utilitiy binaries defines its own aliases list internally].

          Show
          Travis Vitek added a comment - - edited The code that reads the gen_list file doesn't appear to process comments. I couldn't actually find anything that referenced the codeset_aliases file, so it may be garbage left behind [the code in aliases.cpp used by utilitiy binaries defines its own aliases list internally] .
          Hide
          Martin Sebor added a comment -

          I've just merged the latest trunk/doc to branches/4.2.0/doc: http://svn.apache.org/viewvc?rev=584901&view=rev

          I'm not sure gen_list or codeset_aliases allow for comments. If they do, we should add the header. Otherwise there's nothing we can do for 4.2.0 (but remember to extend the locale utilities in 4.2.1 to accept comments.

          Show
          Martin Sebor added a comment - I've just merged the latest trunk/doc to branches/4.2.0/doc: http://svn.apache.org/viewvc?rev=584901&view=rev I'm not sure gen_list or codeset_aliases allow for comments. If they do, we should add the header. Otherwise there's nothing we can do for 4.2.0 (but remember to extend the locale utilities in 4.2.1 to accept comments.
          Hide
          Travis Vitek added a comment -

          Here is the list of files without the ASL header.

          C:\Rat>java -jar rat-0.5.1.jar c:\Build\stdcxx-4.2.0-rc5 | find "!?????" | find /v ".out" | find /v ".in"
          !????? c:/Build/stdcxx-4.2.0-rc5/etc/config/src/MADVISE.cpp
          !????? c:/Build/stdcxx-4.2.0-rc5/etc/nls/gen_list
          !????? c:/Build/stdcxx-4.2.0-rc5/etc/nls/charmaps/T.61-8BIT
          !????? c:/Build/stdcxx-4.2.0-rc5/etc/nls/posix/gen_list
          !????? c:/Build/stdcxx-4.2.0-rc5/etc/nls/posix/charmaps/ISO_646.IRV
          !????? c:/Build/stdcxx-4.2.0-rc5/examples/manual/rwstdmessages.cpp
          !????? c:/Build/stdcxx-4.2.0-rc5/examples/manual/rwstdmessages.msg
          !????? c:/Build/stdcxx-4.2.0-rc5/examples/manual/rwstdmessages.rc
          !????? c:/Build/stdcxx-4.2.0-rc5/src/mapfile.gcc
          !????? c:/Build/stdcxx-4.2.0-rc5/src/mapfile.gcc-2
          !????? c:/Build/stdcxx-4.2.0-rc5/util/codeset_aliases
          !????? c:/Build/stdcxx-4.2.0-rc5/util/gen_list

          Of those, only gen_list and codeset_aliases are actually expected to not have the ASL header. The others apparently have not been integrated from trunk.

          Show
          Travis Vitek added a comment - Here is the list of files without the ASL header. C:\Rat>java -jar rat-0.5.1.jar c:\Build\stdcxx-4.2.0-rc5 | find "!?????" | find /v ".out" | find /v ".in" !????? c:/Build/stdcxx-4.2.0-rc5/etc/config/src/MADVISE.cpp !????? c:/Build/stdcxx-4.2.0-rc5/etc/nls/gen_list !????? c:/Build/stdcxx-4.2.0-rc5/etc/nls/charmaps/T.61-8BIT !????? c:/Build/stdcxx-4.2.0-rc5/etc/nls/posix/gen_list !????? c:/Build/stdcxx-4.2.0-rc5/etc/nls/posix/charmaps/ISO_646.IRV !????? c:/Build/stdcxx-4.2.0-rc5/examples/manual/rwstdmessages.cpp !????? c:/Build/stdcxx-4.2.0-rc5/examples/manual/rwstdmessages.msg !????? c:/Build/stdcxx-4.2.0-rc5/examples/manual/rwstdmessages.rc !????? c:/Build/stdcxx-4.2.0-rc5/src/mapfile.gcc !????? c:/Build/stdcxx-4.2.0-rc5/src/mapfile.gcc-2 !????? c:/Build/stdcxx-4.2.0-rc5/util/codeset_aliases !????? c:/Build/stdcxx-4.2.0-rc5/util/gen_list Of those, only gen_list and codeset_aliases are actually expected to not have the ASL header. The others apparently have not been integrated from trunk.
          Hide
          Travis Vitek added a comment -

          Apparently I have to reopen to add files.

          Show
          Travis Vitek added a comment - Apparently I have to reopen to add files.
          Hide
          Martin Sebor added a comment -

          Travis, could you please attach the output of RAT on the latest release candidate for the record?

          Also, when mentioning an issue (such as STDCXX-560, STDCXX-561, and STDCXX-568 above) in comments on another, there is no need to paste a URL to the issue. Jira is smart enough to expand STDCXX-NNN strings into hyperlinks automatically. Not only that, once the referenced issue is closed, Jira crosses it off to indicate the fact in all references to it (apparently, it won't do that if the string is part of a URL).

          Show
          Martin Sebor added a comment - Travis, could you please attach the output of RAT on the latest release candidate for the record? Also, when mentioning an issue (such as STDCXX-560 , STDCXX-561 , and STDCXX-568 above) in comments on another, there is no need to paste a URL to the issue. Jira is smart enough to expand STDCXX-NNN strings into hyperlinks automatically. Not only that, once the referenced issue is closed, Jira crosses it off to indicate the fact in all references to it (apparently, it won't do that if the string is part of a URL).
          Hide
          Travis Vitek added a comment -

          There are a few more patches that need to be applied for this case to be considered closed. I'm linking to the issues here.

          http://issues.apache.org/jira/browse/STDCXX-560 [missed-config.patch]
          http://issues.apache.org/jira/browse/STDCXX-561 [missed-charmaps.patch]
          http://issues.apache.org/jira/browse/STDCXX-568 [map-files.patch, source-files.patch]

          Once those are submitted, the rat-stdcxx-4.2.0-v1 results will be correct. The only files that don't have ASL headers are 'gen_list', 'codeset_aliases' and the .in/.out files for the examples.

          Show
          Travis Vitek added a comment - There are a few more patches that need to be applied for this case to be considered closed. I'm linking to the issues here. http://issues.apache.org/jira/browse/STDCXX-560 [missed-config.patch] http://issues.apache.org/jira/browse/STDCXX-561 [missed-charmaps.patch] http://issues.apache.org/jira/browse/STDCXX-568 [map-files.patch, source-files.patch] Once those are submitted, the rat-stdcxx-4.2.0-v1 results will be correct. The only files that don't have ASL headers are 'gen_list', 'codeset_aliases' and the .in/.out files for the examples.
          Hide
          Martin Sebor added a comment -

          Okay, that's pretty conclusive: every documentation file needs to contain a comment with the ASL header in it. Let me create a subtask for it. It also sounds like every config test (under etc/config/src) must contain such a comment, as do the files under etc/nls/. I'll create another subtask for those. What should not (and cannot) contain such headers is the .in and .out files under the examples/ directory tree.

          Show
          Martin Sebor added a comment - Okay, that's pretty conclusive: every documentation file needs to contain a comment with the ASL header in it. Let me create a subtask for it. It also sounds like every config test (under etc/config/src) must contain such a comment, as do the files under etc/nls/. I'll create another subtask for those. What should not (and cannot) contain such headers is the .in and .out files under the examples/ directory tree.
          Hide
          Travis Vitek added a comment -

          Answer to first question, Instructions for using RAT.

          1. download and install java if necessary http://java.sun.com
          2. download the current RAT jar from http://code.google.com/p/arat/ [rat-0.5.1.jar]
          3. from the command line, execute the jar file [java -jar <path-to-rat.jar> <path-to-source-tree>].

          As for the second question, I found the following [from http://www.apache.org/legal/src-headers.html]

          What if my project includes its web site within a product distribution?
          With few exceptions, all human-readable Apache-developed files that are included within a distribution must include the header text. Documentation, including web site documentation distributed with the release, may include the header text within some form of metadata (such as HTML comments) or as a header or footer appearing in the visible documentation.

          What files in an Apache release do not require a license header?
          A file without any degree of creativity in either its literal elements or its structure is not protected by copyright law; therefore, such a file does not require a license header. If in doubt about the extent of the file's creativity, add the license header to the file.

          I also found some discussion http://www.nabble.com/Rat-tool%2C-Apache-header-and-different-file-types-tf2352902.html#a6553062 that seems to indicate that the documentation should have the ASL header in there.

          Show
          Travis Vitek added a comment - Answer to first question, Instructions for using RAT. 1. download and install java if necessary http://java.sun.com 2. download the current RAT jar from http://code.google.com/p/arat/ [rat-0.5.1.jar] 3. from the command line, execute the jar file [java -jar <path-to-rat.jar> <path-to-source-tree>] . As for the second question, I found the following [from http://www.apache.org/legal/src-headers.html] What if my project includes its web site within a product distribution? With few exceptions, all human-readable Apache-developed files that are included within a distribution must include the header text. Documentation, including web site documentation distributed with the release, may include the header text within some form of metadata (such as HTML comments) or as a header or footer appearing in the visible documentation. What files in an Apache release do not require a license header? A file without any degree of creativity in either its literal elements or its structure is not protected by copyright law; therefore, such a file does not require a license header. If in doubt about the extent of the file's creativity, add the license header to the file. I also found some discussion http://www.nabble.com/Rat-tool%2C-Apache-header-and-different-file-types-tf2352902.html#a6553062 that seems to indicate that the documentation should have the ASL header in there.
          Hide
          Martin Sebor added a comment -

          Also, regarding the documentation HTML files, can you find out how the license notice needs to be embedded? E.g., are we expected to an HTML comment to each page with the license or something else? (I'm sure the ASF doesn't expect each HTML page to have the license header on it.)

          Show
          Martin Sebor added a comment - Also, regarding the documentation HTML files, can you find out how the license notice needs to be embedded? E.g., are we expected to an HTML comment to each page with the license or something else? (I'm sure the ASF doesn't expect each HTML page to have the license header on it.)
          Hide
          Martin Sebor added a comment -

          Great, the output will be helpful!

          Could you also paste in step-by-step instructions on how you set up the tool and ran it to get the output so someone else can do it the next time around if need be?

          Show
          Martin Sebor added a comment - Great, the output will be helpful! Could you also paste in step-by-step instructions on how you set up the tool and ran it to get the output so someone else can do it the next time around if need be?
          Hide
          Travis Vitek added a comment -

          Attach RAT output for entire 4.2.0 tree.

          Show
          Travis Vitek added a comment - Attach RAT output for entire 4.2.0 tree.
          Hide
          Martin Sebor added a comment -

          Running RAT should help verify the completeness of STDCXX-457.

          Show
          Martin Sebor added a comment - Running RAT should help verify the completeness of STDCXX-457 .
          Hide
          Martin Sebor added a comment -

          The query below might be helpful to understand what the Incubator PMC is looking for when they run the tool:
          http://www.nabble.com/forum/Search.jtp?forum=378&local=y&query=rat

          Show
          Martin Sebor added a comment - The query below might be helpful to understand what the Incubator PMC is looking for when they run the tool: http://www.nabble.com/forum/Search.jtp?forum=378&local=y&query=rat
          Hide
          Martin Sebor added a comment -

          This is a Release Management issue: set component to Release.

          Show
          Martin Sebor added a comment - This is a Release Management issue: set component to Release.

            People

            • Assignee:
              Travis Vitek
              Reporter:
              Martin Sebor
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development