Introducing markdown

Makefile

@@ -0,0 +1,21 @@
+ALL_MD=$(wildcard src/*.md)
+ALL_HTML=$(ALL_MD:src/%.md=build/%.html)
+
+.PHONY: all clean
+
+all: build build/guidestyle.css build/devModel.gif $(ALL_HTML)
+
+clean:
+	rm -rf build
+
+build:
+	mkdir build
+
+build/%.html: src/%.md
+	pandoc -o $@ $< --css build/guidestyle.css --strip-comments --standalone
+
+build/guidestyle.css: build src/guidestyle.css
+	cp src/guidestyle.css build/guidestyle.css
+
+build/devModel.gif: build src/devModel.gif
+	cp src/devModel.gif build/devModel.gif

src/bugDatabase.md

@@ -0,0 +1,20 @@
+% The OpenJDK Developers\' Guide: Bug Database
+
+::: {.version}
+version 0.02
+:::
+
+::: {.NavBit}
+[« Previous](next.html) • [TOC](index.html) • [Next »](faq.html)
+:::
+
+The Bug Database section will include the guidelines for triage, priorities,
+and status.
+
+::: {.version}
+version 0.02
+:::
+
+::: {.NavBit}
+[« Previous](next.html) • [TOC](index.html) • [Next »](faq.html)
+:::

src/codeConventions.md

@@ -0,0 +1,20 @@
+% The OpenJDK Developers\' Guide: Code Conventions
+
+::: {.version}
+version 0.02
+:::
+
+::: {.NavBit}
+[« Previous](mailinglists.html) • [TOC](index.html) • [Next »](changePlanning.html)
+:::
+
+This section will contain a major revision of our antiquated code conventions
+[document](https://www.oracle.com/technetwork/java/codeconvtoc-136057.html).
+
+::: {.version}
+version 0.02
+:::
+
+::: {.NavBit}
+[« Previous](mailinglists.html) • [TOC](index.html) • [Next »](changePlanning.html)
+:::

src/codeReview.md

@@ -0,0 +1,115 @@
+% Community Code Review
+
+## General
+
+The cr.openjdk.java.net server provides storage and display of code review
+materials such as webrevs and other artifacts related to the
+[OpenJDK](http://openjdk.java.net/) Community. If you
+are interested in monitoring recent reviews, try our review feed
+[here](http://cr.openjdk.java.net/feed.atom).
+
+Any user with push access to the OpenJDK
+[Mercurial](http://hg.openjdk.java.net) server can publish
+materials on the cr.openjdk.java.net server.
+Users can upload files to temporary
+storage using secure methods (rsync, scp, and sftp).
+
+## Terms and conditions
+
+This site is for open source materials related to the OpenJDK
+Community only. Users uploading inappropriate materials will lose
+access and the material will be deleted. Please review the
+[Terms of Use](http://openjdk.java.net/legal/terms.html).
+
+Special note to developers working on closed code and tests:
+This cr.openjdk.java.net
+server is intended for OpenJDK materials only. Please use your
+current process for webrevs and reviews of closed code and
+tests.
+
+## Webrev
+
+So, what is webrev?
+
+[Webrev](webrevHelp.html) is
+a script that will crawl over your changes, compare the modified
+files with your parent forest, then generate a set of web pages to
+display the differences.
+
+When you are asking reviewers to check over your proposed
+changes, it helps to make that job as easy for them as possible,
+and webrev is one way to do it.
+
+For more information about webrev, refer to:
+
+* See the [the webrev help page](webrevHelp.html)
+
+## Example
+
+* A developer called "username" runs `webrev -f`
+  on their work done in a Mercurial forest. This creates output under
+  a webrev directory.
+
+* For clarity, they add the bug ID they are working on, and
+  perhaps add a sequence number:
+
+>>     mkdir 6543210
+>>     mv webrev 6543210/webrev.00
+
+  This will allow subsequent webrevs (if there are any) to be
+  added as webrev.01 and so on without clobbering the original
+  files.
+
+* **Optional:** If they would like to dress up their entry in
+  the [Atom feed](http://cr.openjdk.java.net/feed.atom),
+  create `.title` and/or `.description` files:
+
+>>     echo "A suitable review title or bug synopsis" > 6543210/.title
+>>     echo "Short description of the change to be reviewed" > 6543210/.description
+
+  Syndication does not recognize line endings or formatting tags,
+  so it would be a good idea to keep the information in these files
+  as simple as possible.
+
+  If these file(s) are not found by the cr.openjdk.java.net
+  server, the subdirectory
+  name (6543210 in this example) will be used for title and/or
+  description in the stream.
+
+* They transfer the webrev tree to their home directory on
+  cr.openjdk.java.net using scp or rsync:
+
+>     scp -r 6543210 username@cr.openjdk.java.net:
+  or
+>     rsync -av 6543210 username@cr.openjdk.java.net:
+
+  Note the final : on the command line. If you omit that, you will
+  copy the bits into a directory called
+  "username@cr.openjdk.java.net" on your local system.
+
+* The results will be published at:
+
+>     http://cr.openjdk.java.net/~username/6543210
+
+* In ten minutes or less, the new information will appear on the
+  feed:
+
+  [http://cr.openjdk.java.net/feed.atom](http://cr.openjdk.java.net/feed.atom)
+
+* Later on, if it is time to clean up, use sftp to access your
+  code review directory:
+
+>     sftp username@cr.openjdk.java.net
+
+  Use the `rm` command to delete individual files. If you
+  want to delete a tree of files and directories, use the
+  `rename` command to move them into your ~/.trash
+  subdirectory. To continue with the example for bug ID 6543210:
+
+>     rename 6543210 .trash/6543210
+
+  A cron job on the cr.openjdk.java.net
+  server will periodically empty the trash for
+  all users.
+
+Please send feedback to `web-discuss at openjdk dot java dot net`

src/faq.md

@@ -0,0 +1,22 @@
+% The OpenJDK Developers\' Guide: Frequently Asked Questions
+
+::: {.version}
+version 0.02
+:::
+
+::: {.NavBit}
+[« Previous](bugDatabase.html) • [TOC](index.html) • [Next »](glossary.html)
+:::
+
+The FAQ is transient. It should only contain things that have not been
+integrated into the main document. If questions remain in the FAQ over more
+than a few revisions, it will be to provide a pointer to the section in the
+main document which contains the answer.
+
+::: {.version}
+version 0.02
+:::
+
+::: {.NavBit}
+[« Previous](bugDatabase.html) • [TOC](index.html) • [Next »](glossary.html)
+:::

src/getSource.md

@@ -0,0 +1,115 @@
+% The OpenJDK Developers\' Guide: `get\_source.sh` Output
+
+::: {.version}
+version 0.02
+:::
+
+::: {.NavBit}
+[« Previous](repositories.html#cloneForest) • [TOC](index.html) • [Next »](repositories.html#cloneSingle)
+:::
+
+>     $ sh ./get_source.sh
+>     # Repositories:  corba jaxp jaxws langtools jdk hotspot nashorn
+>
+>                     corba:   hg clone http://hg.openjdk.java.net/jdk9/dev/corba corba
+>                      jaxp:   hg clone http://hg.openjdk.java.net/jdk9/dev/jaxp jaxp
+>                      jaxp:   requesting all changes
+>                     corba:   requesting all changes
+>                      jaxp:   adding changesets
+>                     corba:   adding changesets
+>                     corba:   adding manifests
+>                      jaxp:   adding manifests
+>                     corba:   adding file changes
+>                      jaxp:   adding file changes
+>     Waiting 5 secs before spawning next background command.
+>                     corba:   added 567 changesets with 3577 changes to 1398 files
+>                     corba:   updating to branch default
+>                     corba:   1195 files updated, 0 files merged, 0 files removed, 0 files unresolved
+>                     jaxws:   hg clone http://hg.openjdk.java.net/jdk9/dev/jaxws jaxws
+>                 langtools:   hg clone http://hg.openjdk.java.net/jdk9/dev/langtools langtools
+>                     jaxws:   requesting all changes
+>                 langtools:   requesting all changes
+>                     jaxws:   adding changesets
+>                 langtools:   adding changesets
+>                     jaxws:   adding manifests
+>                      jaxp:   added 570 changesets with 6285 changes to 4230 files
+>                      jaxp:   updating to branch default
+>     Waiting 5 secs before spawning next background command.
+>                     jaxws:   adding file changes
+>                      jaxp:   2078 files updated, 0 files merged, 0 files removed, 0 files unresolved
+>                 langtools:   adding manifests
+>                 langtools:   adding file changes
+>                       jdk:   hg clone http://hg.openjdk.java.net/jdk9/dev/jdk jdk
+>                   hotspot:   hg clone http://hg.openjdk.java.net/jdk9/dev/hotspot hotspot
+>                   hotspot:   requesting all changes
+>                       jdk:   requesting all changes
+>                   hotspot:   adding changesets
+>                       jdk:   adding changesets
+>     Waiting 5 secs before spawning next background command.
+>                   hotspot:   adding manifests
+>                   nashorn:   hg clone http://hg.openjdk.java.net/jdk9/dev/nashorn nashorn
+>                   nashorn:   requesting all changes
+>                   nashorn:   adding changesets
+>                   nashorn:   adding manifests
+>                   nashorn:   adding file changes
+>                   hotspot:   adding file changes
+>                   nashorn:   added 766 changesets with 6302 changes to 2248 files
+>                   nashorn:   updating to branch default
+>                   nashorn:   2121 files updated, 0 files merged, 0 files removed, 0 files unresolved
+>                     jaxws:   added 471 changesets with 15683 changes to 6727 files
+>                     jaxws:   updating to branch default
+>                       jdk:   adding manifests
+>                 langtools:   added 2326 changesets with 21344 changes to 7022 files
+>                     jaxws:   3710 files updated, 0 files merged, 0 files removed, 0 files unresolved
+>                 langtools:   updating to branch default
+>                 langtools:   6212 files updated, 0 files merged, 0 files removed, 0 files unresolved
+>                   hotspot:   added 5876 changesets with 35016 changes to 5071 files
+>                   hotspot:   updating to branch default
+>                   hotspot:   4183 files updated, 0 files merged, 0 files removed, 0 files unresolved
+>                       jdk:   adding file changes
+>                       jdk:   added 9280 changesets with 86814 changes to 26475 files
+>                       jdk:   updating to branch default
+>                       jdk:   22161 files updated, 0 files merged, 0 files removed, 0 files unresolved
+>     # Repositories:  ./corba . ./hotspot ./jaxp ./jaxws ./jdk ./langtools ./nashorn
+>
+>                   ./corba:   cd ./corba && hg pull -u
+>                         .:   cd . && hg pull -u
+>                 ./hotspot:   cd ./hotspot && hg pull -u
+>                    ./jaxp:   cd ./jaxp && hg pull -u
+>                   ./jaxws:   cd ./jaxws && hg pull -u
+>                     ./jdk:   cd ./jdk && hg pull -u
+>               ./langtools:   cd ./langtools && hg pull -u
+>                 ./nashorn:   cd ./nashorn && hg pull -u
+>                   ./corba:   pulling from http://hg.openjdk.java.net/jdk9/dev/corba
+>                         .:   pulling from http://hg.openjdk.java.net/jdk9/dev
+>                   ./jaxws:   pulling from http://hg.openjdk.java.net/jdk9/dev/jaxws
+>                   ./corba:   searching for changes
+>                   ./corba:   no changes found
+>                     ./jdk:   pulling from http://hg.openjdk.java.net/jdk9/dev/jdk
+>                 ./nashorn:   pulling from http://hg.openjdk.java.net/jdk9/dev/nashorn
+>                         .:   searching for changes
+>                         .:   no changes found
+>                   ./jaxws:   searching for changes
+>                   ./jaxws:   no changes found
+>               ./langtools:   pulling from http://hg.openjdk.java.net/jdk9/dev/langtools
+>                 ./nashorn:   searching for changes
+>                 ./nashorn:   no changes found
+>                     ./jdk:   searching for changes
+>                     ./jdk:   no changes found
+>               ./langtools:   searching for changes
+>               ./langtools:   no changes found
+>                    ./jaxp:   pulling from http://hg.openjdk.java.net/jdk9/dev/jaxp
+>                 ./hotspot:   pulling from http://hg.openjdk.java.net/jdk9/dev/hotspot
+>                    ./jaxp:   searching for changes
+>                    ./jaxp:   no changes found
+>                 ./hotspot:   searching for changes
+>                 ./hotspot:   no changes found
+>     Waiting 5 secs before spawning next background command.
+
+::: {.version}
+version 0.02
+:::
+
+::: {.NavBit}
+[« Previous](repositories.html#cloneForest) • [TOC](index.html) • [Next »](repositories.html#cloneSingle)
+:::

src/glossary.md

@@ -0,0 +1,73 @@
+% The OpenJDK Developers\' Guide: Glossary
+
+::: {.version}
+version 0.02
+:::
+
+::: {.NavBit}
+[« Previous](faq.html) • [TOC](index.html)
+:::
+
+**accepted** (by the CCC)
+:   The stage of the CCC process after "DRAFT", and "PROPOSED". At this stage the
+    primary goals are to ensure that the proposed changes are suitable for the
+    release in a general sense and that the requisite JCK and SQE resources will be
+    available.
+
+**approved** (by the CCC)
+:   The stage of the CCC process after "FINAL". The CCC has approved the final
+   version of the request which permits push into the project forest.
+
+**changeset**
+:   A collection of changes with respect to the current clone of a repository.
+
+**development freeze**
+:   The date by which all planned work should be complete for a particular line of
+    development. After a line's development freeze, only exit-criteria bugs may be
+    fixed in that line.
+
+**forest**
+:   A collection of Mercurial repositories which can be managed as a set of nested
+    repositories. The name "Forest" originally came from the Mercurial "Forest
+    Extension" which can be used with some versions of Mercurial, but in general is
+    no longer recommended. The script
+    `common/bin/hgforest.sh` can be used to apply a
+    Mercurial `hg` command to all the repositories in
+    a forest.
+
+**Group**
+:   A collection of [Participants](/bylaws#participant) who engage in
+    open conversation about a common interest. That interest may be in the
+    creation, enhancement, or maintenance of a specific body of code or it may lie
+    in other areas, e.g., quality, documentation, or evangelism. See the
+    [Group overview](../groups/).
+
+**Mercurial**
+:   A free, cross-platform, distributed source management tool. Source bundles and
+    binary packages for Mercurial are available at
+    [http://www.selenic.com/mercurial/wiki/index.cgi](http://www.selenic.com/mercurial/wiki/index.cgi/Mercurial).
+    The main Mercurial documentation is available at
+    [http://hgbook.red-bean.com](http://hgbook.red-bean.com/).
+
+**Project**
+:   A collaborative effort to produce a specific artifact, which may be a body of
+    code, or documentation, or some other material. See the
+    [Project overview](../projects/).
+
+**repository**
+:   A directory tree in the filesystem that Mercurial treats specially. This tree
+   contains the source files and their revision history.
+
+**webrev**
+:   A tool and its output. In JDK release forests, the script,
+    [`webrev.ksh`](http://hg.openjdk.java.net/code-tools/webrev/raw-file/tip/webrev.ksh),
+    examines a forest or repository to generate a set of web-based views of
+    differences.
+
+::: {.version}
+version 0.02
+:::
+
+::: {.NavBit}
+[« Previous](faq.html) • [TOC](index.html)
+:::

src/guidestyle.css

@@ -0,0 +1,4 @@
+DIV.version {text-align: right ; font-style: italic }
+TD.aligned  {vertical-align: top ; padding-right: 1em }
+H3 { font-size: 10pt; font-weight: bold; font-style: italic;
+     padding: 0pt; margin: 1.5ex 0pt 0pt 0pt; }