[
https://issues.apache.org/jira/browse/DERBY-3985?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12658682#action_12658682
]
Knut Anders Hatlen commented on DERBY-3985:
-------------------------------------------
The description looks fine to me. Some small issues:
- There are some problems with the HTML (for instance end tags with no matching
opening tag). You may want to pass it through an HTML validator (for instance
http://validator.w3.org).
- Should the document be made self-contained? Now it embeds images from
https://issues.apache.org. It would be good if one didn't need a network
connection to see all the contents (and are the URLs on issues.apache.org
stable?).
- Should the advanced build section mention the j14lib and j15lib properties? I
think they still work, and they are somewhat simpler than
java*compile.classpath, but they don't work on all JREs.
- The description of java15compile.classpath and java14compile.classpath says
"The Derby tries to find". Should this be "The Derby build tries to find"?
> Replace BUILDING.txt with a simlified up-to-date BUILDING.html
> --------------------------------------------------------------
>
> Key: DERBY-3985
> URL: https://issues.apache.org/jira/browse/DERBY-3985
> Project: Derby
> Issue Type: Improvement
> Components: Build tools
> Affects Versions: 10.5.0.0
> Reporter: Rick Hillegas
> Assignee: Rick Hillegas
> Attachments: derby-3985-01-aa-simplerBuildInstructions.diff
>
>
> At this point, BUILDING.txt contains a number of mis-statements. It is
> structured in a way which makes the Derby build look complicated and
> intimidating. The build instructions need to be thoroughly overhauled and
> divided into two main sections:
> 1) The simple build instructions for people who are new to the community.
> This will be a build with few pre-requisites which just works out of the box.
> 2) Trickier build instructions for people who want compile-time checks for
> the different platforms which Derby supports.
> While we're at it, I suggest that the revised instructions live in an html
> file rather than a flat text file. I think this will result in a document
> that is more readable and easier to navigate.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
