Skip to content

Commit

Permalink
Remove from documentation that lines in ocp.ini can span multiple lin…
Browse files Browse the repository at this point in the history
…es using \ character
  • Loading branch information
mywave82 committed Sep 23, 2022
1 parent e23a039 commit 02cfc93
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 28 deletions.
14 changes: 0 additions & 14 deletions doc/opencp.dox.in
Original file line number Diff line number Diff line change
Expand Up @@ -1402,20 +1402,6 @@ both options are totally independent of each other.
~;~. The rest of the line starting from the ~;~ is considered as a comment and not
processed.

Normally the definition for an option ends with the end of the line. If many
parameters are needed to specify an option they may exceed the default line
width of 80 characters. Although this is no problem for OCP it is not nice
looking. You can extend a line logically by using the unix like ~backquote~ at
the end of a line to begin a new line without interrupting the current option
definition.

\[example\]
option1=parameter1 parameter2
option2=parameter1 \\
parameter2

Both optains contain exactly the same parameters.

When modifying the configuration you should always start with the default
configuration file and configure it to your needs. Building a bug free config
file from scratch is difficult.
Expand Down
14 changes: 0 additions & 14 deletions doc/texi/configuration.texi
Original file line number Diff line number Diff line change
Expand Up @@ -51,20 +51,6 @@ Comments can be placed anywhere in the configuration file and are
marked by a @emph{;}. The rest of the line starting from the
@emph{;} is considered as a comment and not processed.

Normally the definition for an option ends with the end of the
line. If many parameters are needed to specify an option they may
exceed the default line width of 80 characters. Although this is no
problem for OCP it is not nice looking. You can extend a line
logically by using the unix like @emph{backquote} at the end of a line
to begin a newline without interupting the current option definition.
@example
[example]
option1=parameter1 parameter2
option2=parameter1 \
parameter2
@end example
Both options contain exactly the same parameters.

When modifying the configuration you should always start with the
default configuration file and configure it to your needs. Building a
bug free config file from scratch is difficult. @footnote{And remember
Expand Down

0 comments on commit 02cfc93

Please sign in to comment.