Re-arrange sections in the Guide

Jesper Wilhelmsson jesper.wilhelmsson at oracle.com
Wed Nov 4 11:22:06 UTC 2020


Hi,

I'd like to re-arrange the sections in the Guide. I think that we should start with the mailing lists because that's where any OpenJDK interaction should start. "Change Planning and Guidelines" currently only have one section, "Fixing a bug", and I think that section is important enough to stand on it's own, so I suggest to skip the first header. JBS should have a section with more JBS stuff, and things like "Filing a bug" could fit there I think. If you look for information on how to file a bug I think it will be easier to find it if there is a section called JBS rather than "What Happens Next".

This is my suggestion for a new index:

• Introduction
• Mailing Lists
	• Changing your email address
• Repositories
	• Terminology and Naming Scheme
	• Installing and Configuring Mercurial
	• Cloning
• Building the OpenJDK  -- (In the making)
• Code Conventions
• JBS - JDK Bug System
	• Filing a Bug
	• JBS Label Dictionary
• Fixing a Bug
• Testing Changes
	• JTReg
		• Running OpenJDK JTReg Tests
	• GTest
		• Running OpenJDK GTests
	• Excluding a Test
		• ProblemListing jtreg tests
		• Exclude jtreg tests using @ignore
		• Dealing with JBS bugs for test exclusion
• Producing a Changeset
	• Setting a JDK User Name
	• Creating
	• Merging
	• Pushing
• Backing Out a Change
	• How to work with JBS when a change is backed out
	• How to work with mercurial when a change is backed out
• Code Owners
	• Area mailing lists
	• Directory to area mapping
• About this Guide
• Glossary


Let me know what you think.

Thanks,
/Jesper



More information about the guide-dev mailing list