Lucene - Core
  1. Lucene - Core
  2. LUCENE-1898

Decide if we should remove lines numbers from latest Changes

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 2.9
    • Component/s: core/other
    • Labels:
      None
    • Lucene Fields:
      New, Patch Available

      Description

      As Lucene dev has grown, a new issue has arisen - many times, new changes invalidate old changes. A proper changes file should just list the changes from the last version, not document the dev life of the issues. Keeping changes in proper order now requires a lot of renumbering sometimes. The numbers have no real meaning and could be added to more rich versions (such as the html version) automatically if desired.

      I think an * makes a good replacement myself. The issues already have ids that are stable, rather than the current, decorational numbers which are subject to change over a dev cycle.

      I think we should replace the numbers with an asterix for the 2.9 section and going forward (ie 4. becomes *).

      If we don't get consensus very quickly, this issue won't block.

      1. LUCENE-1898.patch
        46 kB
        Mark Miller
      2. LUCENE-1898.patch
        60 kB
        Steve Rowe

        Activity

        Hide
        Steve Rowe added a comment - - edited

        changes2html.pl doesn't fully grok the new format - items are numbered, but the asterisks are left in in some cases. I'll work up a patch.

        Show
        Steve Rowe added a comment - - edited changes2html.pl doesn't fully grok the new format - items are numbered, but the asterisks are left in in some cases. I'll work up a patch.
        Hide
        Robert Muir added a comment -

        contrib/benchmark CHANGES has a different format (dates instead of numbers), and maybe do this for contrib/CHANGES too?

        Show
        Robert Muir added a comment - contrib/benchmark CHANGES has a different format (dates instead of numbers), and maybe do this for contrib/CHANGES too?
        Hide
        Yonik Seeley added a comment -

        +1, makes sense.

        Show
        Yonik Seeley added a comment - +1, makes sense.
        Hide
        Steve Rowe added a comment - - edited

        Patch to changes2html.pl that can handle '*' as bulleted item indicator. Also converts numbered items in contrib/CHANGES.txt for 2.9 release to '*' bullets.

        This patch incorporates Mark's numbered->bulleted modifications to CHANGES.txt, as well as correcting one numbered item that Mark missed, and converting tabs to spaces in the first <code> section, so that the method parameters line up in the output HTML.

        Show
        Steve Rowe added a comment - - edited Patch to changes2html.pl that can handle '*' as bulleted item indicator. Also converts numbered items in contrib/CHANGES.txt for 2.9 release to '*' bullets. This patch incorporates Mark's numbered->bulleted modifications to CHANGES.txt, as well as correcting one numbered item that Mark missed, and converting tabs to spaces in the first <code> section, so that the method parameters line up in the output HTML.
        Hide
        Shai Erera added a comment -

        +1. makes sense. Even in the HTML I don't think it's necessary for the changes to be numbered. Bullets will also work for me.

        Show
        Shai Erera added a comment - +1. makes sense. Even in the HTML I don't think it's necessary for the changes to be numbered. Bullets will also work for me.
        Hide
        Michael McCandless added a comment -

        +1

        Show
        Michael McCandless added a comment - +1
        Hide
        Uwe Schindler added a comment -

        +1 That would be really nice. We always have this duplicate numbers, cascading renumbering and so on. I think, numbering of items is part of the presentation layer (like in XHTML where you have numbered lists)

        Show
        Uwe Schindler added a comment - +1 That would be really nice. We always have this duplicate numbers, cascading renumbering and so on. I think, numbering of items is part of the presentation layer (like in XHTML where you have numbered lists)
        Hide
        Mark Miller added a comment -

        Thanks a million Steve!

        r812493

        Show
        Mark Miller added a comment - Thanks a million Steve! r812493

          People

          • Assignee:
            Mark Miller
            Reporter:
            Mark Miller
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development