You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-dev@db.apache.org by "Kim Haase (JIRA)" <ji...@apache.org> on 2007/12/07 19:03:48 UTC
[jira] Created: (DERBY-3262) Documentation is missing
cross-references for connection URL attributes
Documentation is missing cross-references for connection URL attributes
-----------------------------------------------------------------------
Key: DERBY-3262
URL: https://issues.apache.org/jira/browse/DERBY-3262
Project: Derby
Issue Type: Bug
Components: Documentation
Affects Versions: 10.3.1.4
Reporter: Kim Haase
Assignee: Kim Haase
Priority: Minor
As part of a plan to improve the documentation of connection URL attributes, I've found some topics that mention these attributes but don't point to reference information about them. These topics should point to the descriptions of the attributes in the Reference Manual, and the Reference Manual topics should in turn point to some of them.
In the Admin Guide: http://db.apache.org/derby/docs/dev/adminguide/tadminhubbkup44.html (Restoring a database from a backup copy) lacks a reference to the restoreFrom=Path URL attribute description in the Reference Manual (http://db.apache.org/derby/docs/dev/ref/rrefrestorefrom.html) and vice versa.
http://db.apache.org/derby/docs/dev/adminguide/tadmincrtdbbkup.html (Creating a database from a backup copy) lacks a reference to the createFrom=Path URL attribute description in the Reference Manual (http://db.apache.org/derby/docs/dev/ref/rrefcreatefrom.html) and vice versa.
http://db.apache.org/derby/docs/dev/adminguide/tadminlog800206.html (Using the logDevice attribute) lacks a reference to the logDevice=logDirectoryPath URL attribute description in the Reference Manual (http://db.apache.org/derby/docs/dev/ref/rrefattrib72457.html) and vice versa. It also needs to observe the convention of calling the attribute logDevice=logDirectoryPath rather than just logDevice. Its parent topic, Logging on a separate device (http://db.apache.org/derby/docs/dev/adminguide/cadminlog98.html), needs to observe the naming convention also.
http://db.apache.org/derby/docs/dev/adminguide/cadminappsclienttracing.html should refer to the URL attribute topics related to tracing in the Reference Manual. The Reference Manual topics already refer to this topic. Currently, traceFileAppend isn't mentioned in cadminappsclienttracing.html; it should be added, and the naming convention should also be observed.
The task topic http://db.apache.org/derby/docs/dev/adminguide/cadminrollforward.html (Roll-forward recovery) mentions the rollForwardRecoveryFrom=path URL attribute description in the Reference Manual (http://db.apache.org/derby/docs/dev/ref/rrefrollforward.html) but uses older documentation conventions to refer to it, and duplicates some information. It should be updated.
In the Tuning Guide:
http://db.apache.org/derby/docs/dev/tuning/ctunsetprop38343.html (Using a properties object within an application or statement) has a note on connection URL attributes that lacks a cross-reference either to the main Reference Manual section (http://db.apache.org/derby/docs/dev/ref/rrefattrib24612.html) or to the information about the DriverManager.getConnection method, which is also mentioned (http://db.apache.org/derby/docs/dev/ref/rrefjdbc34565.html).
In the Tools Guide:
http://db.apache.org/derby/docs/dev/tools/ctoolsijtools16011.html (Database connection URLs) probably duplicates information that exists elsewhere, but the immediate problem is that it contains references to the Developer's Guide only. It should also have a reference to the Reference Manual http://db.apache.org/derby/docs/dev/ref/rrefattrib24612.html). Ideally, the Developer's Guide references should be to specific topics rather than to the entire manual, but the Developer's Guide has a lot of duplication in this area that's a whole separate problem, and I don't want to add something that might have to be backed out later.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (DERBY-3262) Documentation is missing
cross-references for connection URL attributes
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-3262?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Kim Haase updated DERBY-3262:
-----------------------------
Attachment: DERBY-3262.stat
DERBY-3262.zip
DERBY-3262.diff
Attaching DERBY-3262.diff, DERBY-3262.zip, and DERBY-3262.stat, containing changes to the following files:
M src/tools/ctoolsijtools16011.dita
M src/tuning/ctunsetprop38343.dita
M src/adminguide/cadminrollforward.dita
M src/adminguide/tadminhubbkup44.dita
M src/adminguide/tadminlog800206.dita
M src/adminguide/cadminlog98.dita
M src/adminguide/cadminappsclienttracing.dita
M src/adminguide/tadmincrtdbbkup.dita
M src/ref/rrefcreatefrom.dita
M src/ref/rrefrestorefrom.dita
M src/ref/rrefattrib72457.dita
M src/ref/rrefrollforward.dita
> Documentation is missing cross-references for connection URL attributes
> -----------------------------------------------------------------------
>
> Key: DERBY-3262
> URL: https://issues.apache.org/jira/browse/DERBY-3262
> Project: Derby
> Issue Type: Bug
> Components: Documentation
> Affects Versions: 10.3.1.4
> Reporter: Kim Haase
> Assignee: Kim Haase
> Priority: Minor
> Attachments: DERBY-3262.diff, DERBY-3262.stat, DERBY-3262.zip
>
>
> As part of a plan to improve the documentation of connection URL attributes, I've found some topics that mention these attributes but don't point to reference information about them. These topics should point to the descriptions of the attributes in the Reference Manual, and the Reference Manual topics should in turn point to some of them.
> In the Admin Guide: http://db.apache.org/derby/docs/dev/adminguide/tadminhubbkup44.html (Restoring a database from a backup copy) lacks a reference to the restoreFrom=Path URL attribute description in the Reference Manual (http://db.apache.org/derby/docs/dev/ref/rrefrestorefrom.html) and vice versa.
> http://db.apache.org/derby/docs/dev/adminguide/tadmincrtdbbkup.html (Creating a database from a backup copy) lacks a reference to the createFrom=Path URL attribute description in the Reference Manual (http://db.apache.org/derby/docs/dev/ref/rrefcreatefrom.html) and vice versa.
> http://db.apache.org/derby/docs/dev/adminguide/tadminlog800206.html (Using the logDevice attribute) lacks a reference to the logDevice=logDirectoryPath URL attribute description in the Reference Manual (http://db.apache.org/derby/docs/dev/ref/rrefattrib72457.html) and vice versa. It also needs to observe the convention of calling the attribute logDevice=logDirectoryPath rather than just logDevice. Its parent topic, Logging on a separate device (http://db.apache.org/derby/docs/dev/adminguide/cadminlog98.html), needs to observe the naming convention also.
> http://db.apache.org/derby/docs/dev/adminguide/cadminappsclienttracing.html should refer to the URL attribute topics related to tracing in the Reference Manual. The Reference Manual topics already refer to this topic. Currently, traceFileAppend isn't mentioned in cadminappsclienttracing.html; it should be added, and the naming convention should also be observed.
> The task topic http://db.apache.org/derby/docs/dev/adminguide/cadminrollforward.html (Roll-forward recovery) mentions the rollForwardRecoveryFrom=path URL attribute description in the Reference Manual (http://db.apache.org/derby/docs/dev/ref/rrefrollforward.html) but uses older documentation conventions to refer to it, and duplicates some information. It should be updated.
> In the Tuning Guide:
> http://db.apache.org/derby/docs/dev/tuning/ctunsetprop38343.html (Using a properties object within an application or statement) has a note on connection URL attributes that lacks a cross-reference either to the main Reference Manual section (http://db.apache.org/derby/docs/dev/ref/rrefattrib24612.html) or to the information about the DriverManager.getConnection method, which is also mentioned (http://db.apache.org/derby/docs/dev/ref/rrefjdbc34565.html).
> In the Tools Guide:
> http://db.apache.org/derby/docs/dev/tools/ctoolsijtools16011.html (Database connection URLs) probably duplicates information that exists elsewhere, but the immediate problem is that it contains references to the Developer's Guide only. It should also have a reference to the Reference Manual http://db.apache.org/derby/docs/dev/ref/rrefattrib24612.html). Ideally, the Developer's Guide references should be to specific topics rather than to the entire manual, but the Developer's Guide has a lot of duplication in this area that's a whole separate problem, and I don't want to add something that might have to be backed out later.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (DERBY-3262) Documentation is missing
cross-references for connection URL attributes
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-3262?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12550705 ]
Kim Haase commented on DERBY-3262:
----------------------------------
Thanks very much, Dyre.
> Documentation is missing cross-references for connection URL attributes
> -----------------------------------------------------------------------
>
> Key: DERBY-3262
> URL: https://issues.apache.org/jira/browse/DERBY-3262
> Project: Derby
> Issue Type: Bug
> Components: Documentation
> Affects Versions: 10.3.1.4
> Reporter: Kim Haase
> Assignee: Kim Haase
> Priority: Minor
> Attachments: DERBY-3262.diff, DERBY-3262.stat, DERBY-3262.zip
>
>
> As part of a plan to improve the documentation of connection URL attributes, I've found some topics that mention these attributes but don't point to reference information about them. These topics should point to the descriptions of the attributes in the Reference Manual, and the Reference Manual topics should in turn point to some of them.
> In the Admin Guide: http://db.apache.org/derby/docs/dev/adminguide/tadminhubbkup44.html (Restoring a database from a backup copy) lacks a reference to the restoreFrom=Path URL attribute description in the Reference Manual (http://db.apache.org/derby/docs/dev/ref/rrefrestorefrom.html) and vice versa.
> http://db.apache.org/derby/docs/dev/adminguide/tadmincrtdbbkup.html (Creating a database from a backup copy) lacks a reference to the createFrom=Path URL attribute description in the Reference Manual (http://db.apache.org/derby/docs/dev/ref/rrefcreatefrom.html) and vice versa.
> http://db.apache.org/derby/docs/dev/adminguide/tadminlog800206.html (Using the logDevice attribute) lacks a reference to the logDevice=logDirectoryPath URL attribute description in the Reference Manual (http://db.apache.org/derby/docs/dev/ref/rrefattrib72457.html) and vice versa. It also needs to observe the convention of calling the attribute logDevice=logDirectoryPath rather than just logDevice. Its parent topic, Logging on a separate device (http://db.apache.org/derby/docs/dev/adminguide/cadminlog98.html), needs to observe the naming convention also.
> http://db.apache.org/derby/docs/dev/adminguide/cadminappsclienttracing.html should refer to the URL attribute topics related to tracing in the Reference Manual. The Reference Manual topics already refer to this topic. Currently, traceFileAppend isn't mentioned in cadminappsclienttracing.html; it should be added, and the naming convention should also be observed.
> The task topic http://db.apache.org/derby/docs/dev/adminguide/cadminrollforward.html (Roll-forward recovery) mentions the rollForwardRecoveryFrom=path URL attribute description in the Reference Manual (http://db.apache.org/derby/docs/dev/ref/rrefrollforward.html) but uses older documentation conventions to refer to it, and duplicates some information. It should be updated.
> In the Tuning Guide:
> http://db.apache.org/derby/docs/dev/tuning/ctunsetprop38343.html (Using a properties object within an application or statement) has a note on connection URL attributes that lacks a cross-reference either to the main Reference Manual section (http://db.apache.org/derby/docs/dev/ref/rrefattrib24612.html) or to the information about the DriverManager.getConnection method, which is also mentioned (http://db.apache.org/derby/docs/dev/ref/rrefjdbc34565.html).
> In the Tools Guide:
> http://db.apache.org/derby/docs/dev/tools/ctoolsijtools16011.html (Database connection URLs) probably duplicates information that exists elsewhere, but the immediate problem is that it contains references to the Developer's Guide only. It should also have a reference to the Reference Manual http://db.apache.org/derby/docs/dev/ref/rrefattrib24612.html). Ideally, the Developer's Guide references should be to specific topics rather than to the entire manual, but the Developer's Guide has a lot of duplication in this area that's a whole separate problem, and I don't want to add something that might have to be backed out later.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Closed: (DERBY-3262) Documentation is missing
cross-references for connection URL attributes
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-3262?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Kim Haase closed DERBY-3262.
----------------------------
Thanks again, Dyre.
> Documentation is missing cross-references for connection URL attributes
> -----------------------------------------------------------------------
>
> Key: DERBY-3262
> URL: https://issues.apache.org/jira/browse/DERBY-3262
> Project: Derby
> Issue Type: Bug
> Components: Documentation
> Affects Versions: 10.3.1.4
> Reporter: Kim Haase
> Assignee: Kim Haase
> Priority: Minor
> Fix For: 10.4.0.0
>
> Attachments: DERBY-3262.diff, DERBY-3262.stat, DERBY-3262.zip
>
>
> As part of a plan to improve the documentation of connection URL attributes, I've found some topics that mention these attributes but don't point to reference information about them. These topics should point to the descriptions of the attributes in the Reference Manual, and the Reference Manual topics should in turn point to some of them.
> In the Admin Guide: http://db.apache.org/derby/docs/dev/adminguide/tadminhubbkup44.html (Restoring a database from a backup copy) lacks a reference to the restoreFrom=Path URL attribute description in the Reference Manual (http://db.apache.org/derby/docs/dev/ref/rrefrestorefrom.html) and vice versa.
> http://db.apache.org/derby/docs/dev/adminguide/tadmincrtdbbkup.html (Creating a database from a backup copy) lacks a reference to the createFrom=Path URL attribute description in the Reference Manual (http://db.apache.org/derby/docs/dev/ref/rrefcreatefrom.html) and vice versa.
> http://db.apache.org/derby/docs/dev/adminguide/tadminlog800206.html (Using the logDevice attribute) lacks a reference to the logDevice=logDirectoryPath URL attribute description in the Reference Manual (http://db.apache.org/derby/docs/dev/ref/rrefattrib72457.html) and vice versa. It also needs to observe the convention of calling the attribute logDevice=logDirectoryPath rather than just logDevice. Its parent topic, Logging on a separate device (http://db.apache.org/derby/docs/dev/adminguide/cadminlog98.html), needs to observe the naming convention also.
> http://db.apache.org/derby/docs/dev/adminguide/cadminappsclienttracing.html should refer to the URL attribute topics related to tracing in the Reference Manual. The Reference Manual topics already refer to this topic. Currently, traceFileAppend isn't mentioned in cadminappsclienttracing.html; it should be added, and the naming convention should also be observed.
> The task topic http://db.apache.org/derby/docs/dev/adminguide/cadminrollforward.html (Roll-forward recovery) mentions the rollForwardRecoveryFrom=path URL attribute description in the Reference Manual (http://db.apache.org/derby/docs/dev/ref/rrefrollforward.html) but uses older documentation conventions to refer to it, and duplicates some information. It should be updated.
> In the Tuning Guide:
> http://db.apache.org/derby/docs/dev/tuning/ctunsetprop38343.html (Using a properties object within an application or statement) has a note on connection URL attributes that lacks a cross-reference either to the main Reference Manual section (http://db.apache.org/derby/docs/dev/ref/rrefattrib24612.html) or to the information about the DriverManager.getConnection method, which is also mentioned (http://db.apache.org/derby/docs/dev/ref/rrefjdbc34565.html).
> In the Tools Guide:
> http://db.apache.org/derby/docs/dev/tools/ctoolsijtools16011.html (Database connection URLs) probably duplicates information that exists elsewhere, but the immediate problem is that it contains references to the Developer's Guide only. It should also have a reference to the Reference Manual http://db.apache.org/derby/docs/dev/ref/rrefattrib24612.html). Ideally, the Developer's Guide references should be to specific topics rather than to the entire manual, but the Developer's Guide has a lot of duplication in this area that's a whole separate problem, and I don't want to add something that might have to be backed out later.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (DERBY-3262) Documentation is missing
cross-references for connection URL attributes
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-3262?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Kim Haase updated DERBY-3262:
-----------------------------
Derby Info: [Patch Available]
> Documentation is missing cross-references for connection URL attributes
> -----------------------------------------------------------------------
>
> Key: DERBY-3262
> URL: https://issues.apache.org/jira/browse/DERBY-3262
> Project: Derby
> Issue Type: Bug
> Components: Documentation
> Affects Versions: 10.3.1.4
> Reporter: Kim Haase
> Assignee: Kim Haase
> Priority: Minor
> Attachments: DERBY-3262.diff, DERBY-3262.stat, DERBY-3262.zip
>
>
> As part of a plan to improve the documentation of connection URL attributes, I've found some topics that mention these attributes but don't point to reference information about them. These topics should point to the descriptions of the attributes in the Reference Manual, and the Reference Manual topics should in turn point to some of them.
> In the Admin Guide: http://db.apache.org/derby/docs/dev/adminguide/tadminhubbkup44.html (Restoring a database from a backup copy) lacks a reference to the restoreFrom=Path URL attribute description in the Reference Manual (http://db.apache.org/derby/docs/dev/ref/rrefrestorefrom.html) and vice versa.
> http://db.apache.org/derby/docs/dev/adminguide/tadmincrtdbbkup.html (Creating a database from a backup copy) lacks a reference to the createFrom=Path URL attribute description in the Reference Manual (http://db.apache.org/derby/docs/dev/ref/rrefcreatefrom.html) and vice versa.
> http://db.apache.org/derby/docs/dev/adminguide/tadminlog800206.html (Using the logDevice attribute) lacks a reference to the logDevice=logDirectoryPath URL attribute description in the Reference Manual (http://db.apache.org/derby/docs/dev/ref/rrefattrib72457.html) and vice versa. It also needs to observe the convention of calling the attribute logDevice=logDirectoryPath rather than just logDevice. Its parent topic, Logging on a separate device (http://db.apache.org/derby/docs/dev/adminguide/cadminlog98.html), needs to observe the naming convention also.
> http://db.apache.org/derby/docs/dev/adminguide/cadminappsclienttracing.html should refer to the URL attribute topics related to tracing in the Reference Manual. The Reference Manual topics already refer to this topic. Currently, traceFileAppend isn't mentioned in cadminappsclienttracing.html; it should be added, and the naming convention should also be observed.
> The task topic http://db.apache.org/derby/docs/dev/adminguide/cadminrollforward.html (Roll-forward recovery) mentions the rollForwardRecoveryFrom=path URL attribute description in the Reference Manual (http://db.apache.org/derby/docs/dev/ref/rrefrollforward.html) but uses older documentation conventions to refer to it, and duplicates some information. It should be updated.
> In the Tuning Guide:
> http://db.apache.org/derby/docs/dev/tuning/ctunsetprop38343.html (Using a properties object within an application or statement) has a note on connection URL attributes that lacks a cross-reference either to the main Reference Manual section (http://db.apache.org/derby/docs/dev/ref/rrefattrib24612.html) or to the information about the DriverManager.getConnection method, which is also mentioned (http://db.apache.org/derby/docs/dev/ref/rrefjdbc34565.html).
> In the Tools Guide:
> http://db.apache.org/derby/docs/dev/tools/ctoolsijtools16011.html (Database connection URLs) probably duplicates information that exists elsewhere, but the immediate problem is that it contains references to the Developer's Guide only. It should also have a reference to the Reference Manual http://db.apache.org/derby/docs/dev/ref/rrefattrib24612.html). Ideally, the Developer's Guide references should be to specific topics rather than to the entire manual, but the Developer's Guide has a lot of duplication in this area that's a whole separate problem, and I don't want to add something that might have to be backed out later.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (DERBY-3262) Documentation is missing
cross-references for connection URL attributes
Posted by "Dyre Tjeldvoll (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-3262?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Dyre Tjeldvoll updated DERBY-3262:
----------------------------------
Derby Info: (was: [Patch Available])
Committed revision 603587
> Documentation is missing cross-references for connection URL attributes
> -----------------------------------------------------------------------
>
> Key: DERBY-3262
> URL: https://issues.apache.org/jira/browse/DERBY-3262
> Project: Derby
> Issue Type: Bug
> Components: Documentation
> Affects Versions: 10.3.1.4
> Reporter: Kim Haase
> Assignee: Kim Haase
> Priority: Minor
> Attachments: DERBY-3262.diff, DERBY-3262.stat, DERBY-3262.zip
>
>
> As part of a plan to improve the documentation of connection URL attributes, I've found some topics that mention these attributes but don't point to reference information about them. These topics should point to the descriptions of the attributes in the Reference Manual, and the Reference Manual topics should in turn point to some of them.
> In the Admin Guide: http://db.apache.org/derby/docs/dev/adminguide/tadminhubbkup44.html (Restoring a database from a backup copy) lacks a reference to the restoreFrom=Path URL attribute description in the Reference Manual (http://db.apache.org/derby/docs/dev/ref/rrefrestorefrom.html) and vice versa.
> http://db.apache.org/derby/docs/dev/adminguide/tadmincrtdbbkup.html (Creating a database from a backup copy) lacks a reference to the createFrom=Path URL attribute description in the Reference Manual (http://db.apache.org/derby/docs/dev/ref/rrefcreatefrom.html) and vice versa.
> http://db.apache.org/derby/docs/dev/adminguide/tadminlog800206.html (Using the logDevice attribute) lacks a reference to the logDevice=logDirectoryPath URL attribute description in the Reference Manual (http://db.apache.org/derby/docs/dev/ref/rrefattrib72457.html) and vice versa. It also needs to observe the convention of calling the attribute logDevice=logDirectoryPath rather than just logDevice. Its parent topic, Logging on a separate device (http://db.apache.org/derby/docs/dev/adminguide/cadminlog98.html), needs to observe the naming convention also.
> http://db.apache.org/derby/docs/dev/adminguide/cadminappsclienttracing.html should refer to the URL attribute topics related to tracing in the Reference Manual. The Reference Manual topics already refer to this topic. Currently, traceFileAppend isn't mentioned in cadminappsclienttracing.html; it should be added, and the naming convention should also be observed.
> The task topic http://db.apache.org/derby/docs/dev/adminguide/cadminrollforward.html (Roll-forward recovery) mentions the rollForwardRecoveryFrom=path URL attribute description in the Reference Manual (http://db.apache.org/derby/docs/dev/ref/rrefrollforward.html) but uses older documentation conventions to refer to it, and duplicates some information. It should be updated.
> In the Tuning Guide:
> http://db.apache.org/derby/docs/dev/tuning/ctunsetprop38343.html (Using a properties object within an application or statement) has a note on connection URL attributes that lacks a cross-reference either to the main Reference Manual section (http://db.apache.org/derby/docs/dev/ref/rrefattrib24612.html) or to the information about the DriverManager.getConnection method, which is also mentioned (http://db.apache.org/derby/docs/dev/ref/rrefjdbc34565.html).
> In the Tools Guide:
> http://db.apache.org/derby/docs/dev/tools/ctoolsijtools16011.html (Database connection URLs) probably duplicates information that exists elsewhere, but the immediate problem is that it contains references to the Developer's Guide only. It should also have a reference to the Reference Manual http://db.apache.org/derby/docs/dev/ref/rrefattrib24612.html). Ideally, the Developer's Guide references should be to specific topics rather than to the entire manual, but the Developer's Guide has a lot of duplication in this area that's a whole separate problem, and I don't want to add something that might have to be backed out later.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Resolved: (DERBY-3262) Documentation is missing
cross-references for connection URL attributes
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-3262?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Kim Haase resolved DERBY-3262.
------------------------------
Resolution: Fixed
Fix Version/s: 10.4.0.0
> Documentation is missing cross-references for connection URL attributes
> -----------------------------------------------------------------------
>
> Key: DERBY-3262
> URL: https://issues.apache.org/jira/browse/DERBY-3262
> Project: Derby
> Issue Type: Bug
> Components: Documentation
> Affects Versions: 10.3.1.4
> Reporter: Kim Haase
> Assignee: Kim Haase
> Priority: Minor
> Fix For: 10.4.0.0
>
> Attachments: DERBY-3262.diff, DERBY-3262.stat, DERBY-3262.zip
>
>
> As part of a plan to improve the documentation of connection URL attributes, I've found some topics that mention these attributes but don't point to reference information about them. These topics should point to the descriptions of the attributes in the Reference Manual, and the Reference Manual topics should in turn point to some of them.
> In the Admin Guide: http://db.apache.org/derby/docs/dev/adminguide/tadminhubbkup44.html (Restoring a database from a backup copy) lacks a reference to the restoreFrom=Path URL attribute description in the Reference Manual (http://db.apache.org/derby/docs/dev/ref/rrefrestorefrom.html) and vice versa.
> http://db.apache.org/derby/docs/dev/adminguide/tadmincrtdbbkup.html (Creating a database from a backup copy) lacks a reference to the createFrom=Path URL attribute description in the Reference Manual (http://db.apache.org/derby/docs/dev/ref/rrefcreatefrom.html) and vice versa.
> http://db.apache.org/derby/docs/dev/adminguide/tadminlog800206.html (Using the logDevice attribute) lacks a reference to the logDevice=logDirectoryPath URL attribute description in the Reference Manual (http://db.apache.org/derby/docs/dev/ref/rrefattrib72457.html) and vice versa. It also needs to observe the convention of calling the attribute logDevice=logDirectoryPath rather than just logDevice. Its parent topic, Logging on a separate device (http://db.apache.org/derby/docs/dev/adminguide/cadminlog98.html), needs to observe the naming convention also.
> http://db.apache.org/derby/docs/dev/adminguide/cadminappsclienttracing.html should refer to the URL attribute topics related to tracing in the Reference Manual. The Reference Manual topics already refer to this topic. Currently, traceFileAppend isn't mentioned in cadminappsclienttracing.html; it should be added, and the naming convention should also be observed.
> The task topic http://db.apache.org/derby/docs/dev/adminguide/cadminrollforward.html (Roll-forward recovery) mentions the rollForwardRecoveryFrom=path URL attribute description in the Reference Manual (http://db.apache.org/derby/docs/dev/ref/rrefrollforward.html) but uses older documentation conventions to refer to it, and duplicates some information. It should be updated.
> In the Tuning Guide:
> http://db.apache.org/derby/docs/dev/tuning/ctunsetprop38343.html (Using a properties object within an application or statement) has a note on connection URL attributes that lacks a cross-reference either to the main Reference Manual section (http://db.apache.org/derby/docs/dev/ref/rrefattrib24612.html) or to the information about the DriverManager.getConnection method, which is also mentioned (http://db.apache.org/derby/docs/dev/ref/rrefjdbc34565.html).
> In the Tools Guide:
> http://db.apache.org/derby/docs/dev/tools/ctoolsijtools16011.html (Database connection URLs) probably duplicates information that exists elsewhere, but the immediate problem is that it contains references to the Developer's Guide only. It should also have a reference to the Reference Manual http://db.apache.org/derby/docs/dev/ref/rrefattrib24612.html). Ideally, the Developer's Guide references should be to specific topics rather than to the entire manual, but the Developer's Guide has a lot of duplication in this area that's a whole separate problem, and I don't want to add something that might have to be backed out later.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (DERBY-3262) Documentation is missing
cross-references for connection URL attributes
Posted by "Dyre Tjeldvoll (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-3262?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12550546 ]
Dyre Tjeldvoll commented on DERBY-3262:
---------------------------------------
This looks like a very appropriate change to me. +1.
I plan to commit the patch tomorrow unless there are further comments.
> Documentation is missing cross-references for connection URL attributes
> -----------------------------------------------------------------------
>
> Key: DERBY-3262
> URL: https://issues.apache.org/jira/browse/DERBY-3262
> Project: Derby
> Issue Type: Bug
> Components: Documentation
> Affects Versions: 10.3.1.4
> Reporter: Kim Haase
> Assignee: Kim Haase
> Priority: Minor
> Attachments: DERBY-3262.diff, DERBY-3262.stat, DERBY-3262.zip
>
>
> As part of a plan to improve the documentation of connection URL attributes, I've found some topics that mention these attributes but don't point to reference information about them. These topics should point to the descriptions of the attributes in the Reference Manual, and the Reference Manual topics should in turn point to some of them.
> In the Admin Guide: http://db.apache.org/derby/docs/dev/adminguide/tadminhubbkup44.html (Restoring a database from a backup copy) lacks a reference to the restoreFrom=Path URL attribute description in the Reference Manual (http://db.apache.org/derby/docs/dev/ref/rrefrestorefrom.html) and vice versa.
> http://db.apache.org/derby/docs/dev/adminguide/tadmincrtdbbkup.html (Creating a database from a backup copy) lacks a reference to the createFrom=Path URL attribute description in the Reference Manual (http://db.apache.org/derby/docs/dev/ref/rrefcreatefrom.html) and vice versa.
> http://db.apache.org/derby/docs/dev/adminguide/tadminlog800206.html (Using the logDevice attribute) lacks a reference to the logDevice=logDirectoryPath URL attribute description in the Reference Manual (http://db.apache.org/derby/docs/dev/ref/rrefattrib72457.html) and vice versa. It also needs to observe the convention of calling the attribute logDevice=logDirectoryPath rather than just logDevice. Its parent topic, Logging on a separate device (http://db.apache.org/derby/docs/dev/adminguide/cadminlog98.html), needs to observe the naming convention also.
> http://db.apache.org/derby/docs/dev/adminguide/cadminappsclienttracing.html should refer to the URL attribute topics related to tracing in the Reference Manual. The Reference Manual topics already refer to this topic. Currently, traceFileAppend isn't mentioned in cadminappsclienttracing.html; it should be added, and the naming convention should also be observed.
> The task topic http://db.apache.org/derby/docs/dev/adminguide/cadminrollforward.html (Roll-forward recovery) mentions the rollForwardRecoveryFrom=path URL attribute description in the Reference Manual (http://db.apache.org/derby/docs/dev/ref/rrefrollforward.html) but uses older documentation conventions to refer to it, and duplicates some information. It should be updated.
> In the Tuning Guide:
> http://db.apache.org/derby/docs/dev/tuning/ctunsetprop38343.html (Using a properties object within an application or statement) has a note on connection URL attributes that lacks a cross-reference either to the main Reference Manual section (http://db.apache.org/derby/docs/dev/ref/rrefattrib24612.html) or to the information about the DriverManager.getConnection method, which is also mentioned (http://db.apache.org/derby/docs/dev/ref/rrefjdbc34565.html).
> In the Tools Guide:
> http://db.apache.org/derby/docs/dev/tools/ctoolsijtools16011.html (Database connection URLs) probably duplicates information that exists elsewhere, but the immediate problem is that it contains references to the Developer's Guide only. It should also have a reference to the Reference Manual http://db.apache.org/derby/docs/dev/ref/rrefattrib24612.html). Ideally, the Developer's Guide references should be to specific topics rather than to the entire manual, but the Developer's Guide has a lot of duplication in this area that's a whole separate problem, and I don't want to add something that might have to be backed out later.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.