Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

LUCENE-9344: Convert XXX.txt files to proper XXX.md #1449

Merged
merged 3 commits into from
Apr 24, 2020
Merged

LUCENE-9344: Convert XXX.txt files to proper XXX.md #1449

merged 3 commits into from
Apr 24, 2020

Conversation

mocobeta
Copy link
Contributor

@mocobeta mocobeta commented Apr 23, 2020

Description

Changed README.txt, MIGRATE.txt, etc. to .md and partially fix its markdown formatting.
LICENCE.txt and NOTICE.txt were not modified.

See https://issues.apache.org/jira/browse/LUCENE-9344

Tests

  • Distribution package built by ant package-tgz includes the all .md files
  • TODO: run smoke test This passed nightly-smoke
[smoker] SUCCESS! [0:44:59.564581]

@@ -66,7 +66,7 @@ system.

NOTE: the ~ character represents your user account home directory.

Step 3) Run ant
## Step 4) Run ant
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually it's step 4.

@@ -19,16 +19,16 @@ For reference, JRE major versions with their corresponding Unicode versions:
* Java 8, Unicode 6.2
* Java 9, Unicode 8.0

In general, whether or not you need to re-index largely depends upon the data that
In general, whether you need to re-index largely depends upon the data that
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My linter complained, so fixed the phrasing as it suggested; can be reverted.

of Unicode, you can safely ignore this.

## Special Notes: LUCENE 2.9 TO 3.0, JAVA 1.4 TO JAVA 5 TRANSITION

* `StandardAnalyzer` will return the same results under Java 5 as it did under
Java 1.4. This is because it is largely independent of the runtime JRE for
Unicode support, (with the exception of lowercasing). However, no changes to
Unicode support, (except for lowercasing). However, no changes to
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My linter complained, so fixed the phrasing as it suggested; can be reverted.

@@ -14,5 +14,5 @@ implementing Lucene (document size, number of documents, and number of
hits retrieved to name a few). The benchmarks page has some information
related to performance on particular platforms.

*To build Apache Lucene from source, refer to the `BUILD.txt` file in
*To build Apache Lucene from the source, refer to the `BUILD.txt` file in
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My linter complained, so fixed the phrasing as it suggested; can be reverted.

Copy link
Contributor

@jpountz jpountz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1!

Copy link
Contributor

@dsmiley dsmiley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I viewed them and it looks good!

@mocobeta mocobeta merged commit c7697b0 into apache:master Apr 24, 2020
@mocobeta mocobeta deleted the lucene-change-txt-to-md branch April 24, 2020 05:28
@mocobeta
Copy link
Contributor Author

Thank you for reviewing, I just merge it on the master.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants