Anonymous | Login
Project:
RSS
  
News | My View | View Issues | Roadmap | Summary

View Issue Details[ Jump to Notes ] [ Issue History ] [ Print ]
ID
0005567
TypeCategorySeverityReproducibilityDate SubmittedLast Update
feature request[Openbravo ERP] Z. Othersminorhave not tried2008-10-17 15:472013-06-18 13:03
ReporterplujanView Statuspublic 
Assigned Tojpabloae 
PrioritynormalResolutionfixedFixed in Versionpi
StatusclosedFix in branchpiFixed in SCM revision12270
ProjectionnoneETAnoneTarget Version2.50
OSAnyDatabaseAnyJava version
OS VersionDatabase versionAnt version
Product VersionpiSCM revision 
Review Assigned To
Web browser
ModulesCore
Regression level
Regression date
Regression introduced in release
Regression introduced by commit
Triggers an Emergency PackNo
Summary

0005567: Add self-documentation to configuration files options

DescriptionOpenbravo ERP is turning more and more complex on each new version. And configuration files, like Openbravo.properties can be modified on several ways.
Although config is usually written on installations, sometimes in necessary to hack some parameters.

As an example, look at Apache Tomcat configuration file, server.xml. Or PostgreSQL's pg.conf file. Every parameter is explained, some examples are shown and the most common options are described. A complete how-to about hacking the configuration is on the file itself. This do not avoid config issues, of course, but the most basic questions about what would happen when modifying a value are answered there.
TagsReleaseCandidate
Attached Files

- Relationships [ Relation Graph ] [ Dependency Graph ]

-  Notes
(0009942)
svnbot (reporter)
2008-11-03 15:37

 Repository: openbravo
Revision: 9577
Author: jpabloae
Date: 2008-11-03 15:37:50 +0100 (Mon, 03 Nov 2008)

Related to issue 5567: Reorganize main properties file

---
U trunk/config/Openbravo.properties.template
---

https://dev.openbravo.com/websvn/openbravo/?rev=9577&sc=1 [^]
(0011017)
plujan (manager)
2008-12-06 17:20

 I do not agree about closing this feature request. Please note that the request is about a self-documented properties file. Since 2.50 alpha that file has titles, but is far from self-documented. I added some examples (Tomcat's configuration file and Postgres' one).
Apart from the title, a brief description of the parameter and a detail of the available options is part of a good self-documented file.

Note for QA deparment: please review feature request closing policies to avoid closing incomplete requests.
(0011292)
jpabloae (reporter)
2008-12-13 16:23

 I'm not very friend of long self-documented configuration files. It means maintaining the documentation in 2 places, and most of the times the amoutn of documentation you can include in the file is so amll that you always end up reading the complete one.

You put Tomcat as an example, but if you take that file (conf/server.xml), you'll see that they only refer to external documentation:

  <!--APR library loader. Documentation at /docs/apr.html -->
  <Listener className="org.apache.catalina.core.AprLifecycleListener" SSLEngine="on" />

If you go to http://tomcat.apache.org/tomcat-6.0-doc/apr.html [^] , you'll see that it's not worth it to include all that information in the server.xml file.
(0012639)
svnbot (reporter)
2009-01-26 17:19

 Repository: openbravo
Revision: 12270
Author: jpabloae
Date: 2009-01-26 17:19:56 +0100 (Mon, 26 Jan 2009)

Related to issue 5567: Document Openbravo.properties file in wiki, reorder elements. Link wiki.

---
U trunk/config/Openbravo.properties.template
---

https://dev.openbravo.com/websvn/openbravo/?rev=12270&sc=1 [^]
(0012640)
jpabloae (reporter)
2009-01-26 17:23

 Openbravo.properties documented and liked to http://wiki.openbravo.com/wiki/Openbravo.properties [^]

- Issue History
Date Modified Username Field Change
2008-10-17 15:47 plujan New Issue
2008-10-17 15:47 plujan Assigned To => pjuvara
2008-10-17 15:47 plujan sf_bug_id 0 => 2174817
2008-10-17 15:47 plujan Regression testing => No
2008-10-17 17:43 pjuvara Assigned To pjuvara => jpabloae
2008-10-17 17:43 pjuvara Status new => acknowledged
2008-10-17 17:43 pjuvara Target Version => 2.60
2008-10-17 17:43 pjuvara Summary Configuration files options are not self-documented => Add self-documentation to configuration files options
2008-10-17 17:44 pjuvara Status acknowledged => scheduled
2008-10-17 17:44 pjuvara fix_in_branch => trunk
2008-10-17 17:44 pjuvara Tag Attached: ReleaseCandidate
2008-11-03 15:37 svnbot Checkin
2008-11-03 15:37 svnbot Note Added: 0009942
2008-11-03 15:37 svnbot svn_revision => 9577
2008-11-17 07:36 pjuvara Target Version 2.60 => 2.50
2008-11-17 07:36 pjuvara fix_in_branch trunk =>
2008-11-17 07:37 pjuvara Status scheduled => resolved
2008-11-17 07:37 pjuvara Fixed in Version => 2.50
2008-11-17 07:37 pjuvara Resolution open => fixed
2008-11-26 20:20 pjuvara Status resolved => closed
2008-12-06 17:20 plujan Status closed => new
2008-12-06 17:20 plujan Resolution fixed => open
2008-12-06 17:20 plujan Note Added: 0011017
2008-12-06 17:20 plujan Fixed in Version 2.50 =>
2008-12-13 16:23 jpabloae Note Added: 0011292
2009-01-26 17:19 svnbot Checkin
2009-01-26 17:19 svnbot Note Added: 0012639
2009-01-26 17:19 svnbot svn_revision 9577 => 12270
2009-01-26 17:23 jpabloae Status new => scheduled
2009-01-26 17:23 jpabloae fix_in_branch => trunk
2009-01-26 17:23 jpabloae Note Added: 0012640
2009-01-26 17:28 jpabloae Status scheduled => resolved
2009-01-26 17:28 jpabloae Fixed in Version => trunk
2009-01-26 17:28 jpabloae Resolution open => fixed
2009-05-26 18:02 pjuvara Status resolved => closed
2009-11-09 15:01 jpabloae Project Openbravo ERP => Documentation
2009-11-10 12:57 jpabloae Category D. Documentation => Z Other
2013-06-18 13:00 psanjuan Project Documentation => Openbravo ERP
2013-06-18 13:03 psanjuan Category Z Other => Z. Others

Copyright © 2000 - 2009 MantisBT Group
Powered by Mantis Bugtracker