Skip to content

Commit

Permalink
8176509: Use pandoc for converting build readme to html
Browse files Browse the repository at this point in the history
Reviewed-by: andrew
Backport-of: 9d0bd1b495012de5de1c62f65f14c4de36aef056
  • Loading branch information
zzambers committed Nov 14, 2023
1 parent 0e7ebcb commit 10a653e
Show file tree
Hide file tree
Showing 15 changed files with 1,186 additions and 1,900 deletions.
44 changes: 7 additions & 37 deletions README
Original file line number Diff line number Diff line change
@@ -1,40 +1,10 @@
README:
This file should be located at the top of the OpenJDK Mercurial root
repository. A full OpenJDK repository set (forest) should also include
the following 6 nested repositories:
"jdk", "hotspot", "langtools", "corba", "jaxws" and "jaxp".
Welcome to OpenJDK!
===================

The root repository can be obtained with something like:
hg clone http://hg.openjdk.java.net/jdk8/jdk8 openjdk8

You can run the get_source.sh script located in the root repository to get
the other needed repositories:
cd openjdk8 && sh ./get_source.sh
For information about building OpenJDK, including how to fully retrieve all
source code, please see either of these:

People unfamiliar with Mercurial should read the first few chapters of
the Mercurial book: http://hgbook.red-bean.com/read/
* doc/building.html (html version)
* doc/building.md (markdown version)

See http://openjdk.java.net/ for more information about OpenJDK.

Simple Build Instructions:

0. Get the necessary system software/packages installed on your system, see
http://hg.openjdk.java.net/jdk8/jdk8/raw-file/tip/README-builds.html

1. If you don't have a jdk7u7 or newer jdk, download and install it from
http://java.sun.com/javase/downloads/index.jsp
Add the /bin directory of this installation to your PATH environment
variable.

2. Configure the build:
bash ./configure

3. Build the OpenJDK:
make all
The resulting JDK image should be found in build/*/images/j2sdk-image

where make is GNU make 3.81 or newer, /usr/bin/make on Linux usually
is 3.81 or newer. Note that on Solaris, GNU make is called "gmake".

Complete details are available in the file:
http://hg.openjdk.java.net/jdk8/jdk8/raw-file/tip/README-builds.html
See http://openjdk.java.net/ for more information about OpenJDK.
Loading

3 comments on commit 10a653e

@barracuda156
Copy link

@barracuda156 barracuda156 commented on 10a653e May 8, 2024

Choose a reason for hiding this comment

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

Hi @barracuda156, thanks for making a comment in an OpenJDK project!

All comments and discussions in the OpenJDK Community must be made available under the OpenJDK Terms of Use. If you already are an OpenJDK Author, Committer or Reviewer, please click here to open a new issue so that we can record that fact. Please Use "Add GitHub user barracuda156" for the summary.

If you are not an OpenJDK Author, Committer or Reviewer, simply check the box below to accept the OpenJDK Terms of Use for your comments.

Your comment will be automatically restored once you have accepted the OpenJDK Terms of Use.

@zzambers
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@barracuda156 Dependency on pandoc is optional, it is not needed for normal openjdk build. It's only needed, if you are developer, who makes changes to docs (to regenerate htmls from md).

@barracuda156
Copy link

@barracuda156 barracuda156 commented on 10a653e May 9, 2024

Choose a reason for hiding this comment

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

Hi @barracuda156, thanks for making a comment in an OpenJDK project!

All comments and discussions in the OpenJDK Community must be made available under the OpenJDK Terms of Use. If you already are an OpenJDK Author, Committer or Reviewer, please click here to open a new issue so that we can record that fact. Please Use "Add GitHub user barracuda156" for the summary.

If you are not an OpenJDK Author, Committer or Reviewer, simply check the box below to accept the OpenJDK Terms of Use for your comments.

Your comment will be automatically restored once you have accepted the OpenJDK Terms of Use.

Please sign in to comment.