Sign in Join

Live chat for Free Pascal, Lazarus, Delphi and every Pascal programmer.

Mailing lists / fpc-devel / 2011-12

fpdoc project options

11 messages · 5 people · –

Reply by email Subscribe to this list Your subscription

Read-only archive. Use j and k to move between messages.

Hans-Peter Diettrich

Currently fpdoc stores many options in the project files, but this can cause problems. Once a boolean option is stored as True, e.g. <option name="hide-protected" value="true"/>
it cannot be turned off by a different commandline option :-(

This raises the question, which options should be stored in project files at all, or how the stored options can be overridden by commandline options. The simplest solution would be another commandline option --ignore-project-options (much shorter, if possible), that forces to ignore at least all boolean options read from a project file.

DoDi

Reply by email

Graeme Geldenhuys
to Hans-Peter Diettrich
Hans-Peter Diettrich wrote
Currently fpdoc stores many options in the project files, but this can cause problems. Once a boolean option is stored as True, e.g.  <option name="hide-protected" value="true"/> it cannot be turned off by a different commandline option :-(

I know this might sound silly, but simply edit the project options file?? Wasn't that the whole point of the "lets implement a project file for fpdoc"?

Or copy the existing project option file, change the setting in that copy, then tell fpdoc to use that second copy when it generates docs. Have multiple project files and use one when needed. Please, lets not add more and more command line options... we might just hit the Windows limit again! ;-)

I thought this was the whole point for wanting project files. Have multiple project files, and reduce command line parameters. Please correct me if I am wrong - maybe I misunderstood the reasoning for project files.

Regards,   - Graeme - _______________________________________________ fpGUI - a cross-platform Free Pascal GUI toolkit http://fpgui.sourceforge.net

Reply by email

Hans-Peter Diettrich
to Graeme Geldenhuys
Show quoted text 9 lines
On 4 December 2011 20:09, Hans-Peter Diettrich wrote: > Currently fpdoc stores many options in the project files, but this can cause > problems. Once a boolean option is stored as True, e.g. > <option name="hide-protected" value="true"/> > it cannot be turned off by a different commandline option :-( I know this might sound silly, but simply edit the project options file?? Wasn't that the whole point of the "lets implement a project file for fpdoc"?

When we want to distribute fpdoc project files instead of scripts, a user should not have to edit these files - after every SVN update :-(

It should be sufficient to specify preferences on the fpdoc commandline, which then should override whatever value was stored in the project file. This works for options with arguments, but not for options without arguments.

DoDi

Reply by email

Michael Van Canneyt
to Hans-Peter Diettrich: Currently fpdoc stores many options in the project files, but this can cause problems.…
Hans-Peter Diettrich wrote 10 lines
Currently fpdoc stores many options in the project files, but this can cause problems. Once a boolean option is stored as True, e.g. <option name="hide-protected" value="true"/> it cannot be turned off by a different commandline option :-( This raises the question, which options should be stored in project files at all, or how the stored options can be overridden by commandline options. The simplest solution would be another commandline option --ignore-project-options (much shorter, if possible), that forces to ignore at least all boolean options read from a project file.

You can just remove the <option> tags from the project file, or manipulate the options with the tool I made earlier.

Michael.

Reply by email

Graeme Geldenhuys
to Hans-Peter Diettrich: When we want to distribute fpdoc project files instead of scripts, a user should not have…
Hans-Peter Diettrich wrote
When we want to distribute fpdoc project files instead of scripts, a user should not have to edit these files - after every SVN update :-(

They wouldn't have do it every time after a SVN update. SVN (the last time I checked) does not overwrite all local changes during an update. If there is a conflict (same line of code changed local and remotely), then only will it prompt with a resolution choice: use remote setting or keep local setting.

Regards,   - Graeme - _______________________________________________ fpGUI - a cross-platform Free Pascal GUI toolkit http://fpgui.sourceforge.net

Reply by email

Marco van de Voort
to Graeme Geldenhuys

In our previous episode, Graeme Geldenhuys said:

Show quoted text 8 lines
> When we want to distribute fpdoc project files instead of scripts, a user > should not have to edit these files - after every SVN update :-( They wouldn't have do it every time after a SVN update. SVN (the last time I checked) does not overwrite all local changes during an update. If there is a conflict (same line of code changed local and remotely), then only will it prompt with a resolution choice: use remote setting or keep local setting.

Still it would be the first mandatory edit before making a snapshot. The rest can all be done by just checking out anywhere, and passing some vars to make.

Reply by email

Michael Van Canneyt
to Hans-Peter Diettrich: Still waiting for a description of your tool. BTW, I couldn't find Imports used in…
Hans-Peter Diettrich wrote 6 lines
Michael Van Canneyt schrieb: > You can just remove the <option> tags from the project file, or manipulate > the options with the tool I made earlier. Still waiting for a description of your tool.

Patience.
I have only 2 hands and I have a day-time job to be able to pay for my daily food.

BTW, I couldn't find Imports used in building the documentation any more. Did I miss something?

I forgot to add save/load of imports to the project file. I fixed that.

Michael.

Reply by email

Michael Van Canneyt
to Hans-Peter Diettrich: Sorry, the reference was not found because mkfpdoc is missing from the fpdoc project…
Hans-Peter Diettrich wrote 7 lines
Hans-Peter Diettrich schrieb: > BTW, I couldn't find Imports used in building the documentation any more. > Did I miss something? Sorry, the reference was not found because mkfpdoc is missing from the fpdoc project files - please add it.

To my knowledge, confirmed by SVN, it is in the .lpi project file ?

Michael.

Reply by email