[
https://issues.apache.org/jira/browse/DERBY-2520?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12500770
]
Kim Haase commented on DERBY-2520:
----------------------------------
Thanks, Dag! Everything looks great here. I think your change to
devguide/cdevcsecure36127.dita is fine.
I have only one additional correction.
devguide/rdevcsecure13713.html -- the use of italics is not quite right.
In the two examples, "enduser" is meant to be a literal (that is, not in
italics) -- the actual argument to the procedure. But in the sentence
describing the argument, I put "username" in italics. That's a documentation
convention to indicate that it is a replaceable value. So it would be helpful
if you could remove the italics from the two occurrences of "enduser" and then
replace "enduser" with "username" (still in italics) in the phrase "the value
specified by the derby.user.enduser property". You might also replace "enduser"
in the two examples with something more obviously fictitious, like "redbaron"
to go with the password of "red29PlaNe", so people know it's just an example.
The Reference Manual changes are fine, though I have one suggestion for the
future: as a general rule in technical writing, we don't say "please". We try
to be polite and businesslike, and we also try to avoid excess verbiage. Much
of our writing consists of instructions, and we'd have to say "please" very
often, which might be annoying. No need to remove the word in these files, but
you might keep this in mind for the future. If you end up having to edit them
again to reflect the new behavior from DERBY-2264, you could fix it then.
> Document new restrictions of database shutdown, encryption and hard upgrade
> powers
> ----------------------------------------------------------------------------------
>
> Key: DERBY-2520
> URL: https://issues.apache.org/jira/browse/DERBY-2520
> Project: Derby
> Issue Type: Improvement
> Components: Documentation
> Reporter: Dag H. Wanvik
> Assignee: Dag H. Wanvik
> Fix For: 10.3.0.0
>
> Attachments: DERBY-2520-2.diff, DERBY-2520-2.stat,
> DERBY-2520-2.tar.gz, DERBY-2520-2.zip, DERBY-2520.diff, DERBY-2520.stat,
> DERBY-2520.tar.gz, DERBY-2520.zip
>
>
> Add documentation for the new functionality introduced with DERBY-2264.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
