More documentation fixes #367
Conversation
Explain how fetch_offset and fetch_smear actually function.
It is not clear whether base_url can actually be used as it does not seem that it should be possible for profile to not be a valid URL.
It is applied in the perl code of ccm rather than the component.
|
Test PASSed. |
|
|
||
| A named list containing logrotate structures. | ||
|
|
||
| =head1 ALTLOGROTATE | ||
| Follows the logrotate config format, so see C<< man 8 logrotate >> for a detailed explaination of all options. |
|
minor remarks, LGTM otherwise |
| @@ -13,10 +13,162 @@ The I<altlogrotate> component manages the log rotate configuration files. | |||
|
|
|||
| =head1 RESOURCES | |||
|
|
|||
| =head2 /software/components/altlogrotate/entries | |||
There was a problem hiding this comment.
I can't comment on the line directly because it's not in the diff but please can you fix the @comp on line 8? Also it would be nice to note why this component is called "altlogrotate" rather than logrotate.
There was a problem hiding this comment.
I don't know why, I was wondering that too.
There was a problem hiding this comment.
All I can find is a reference in the CERN twiki saying:
ncm-logrotate 1.0.2 obsoleted by ncm-altlogrotate
There was a problem hiding this comment.
This is the reason. There was an original logrotate component deprecated a while ago in favor of a new one called altlogrotate... This was a long while ago, I think before I actively joined in 2005...
|
Test PASSed. |
1 similar comment
|
Test PASSed. |
|
I was unable to find out what |
|
Test PASSed. |
|
I don't know either but I don't use this configuration module. It would be good to get feedback from somebody using |
jrha
force-pushed
the
more-documentation-fixes
branch
from
adb1cdc
to
5f8d171
Compare
jrha
force-pushed
the
more-documentation-fixes
branch
from
5f8d171
to
f0afc0e
Compare
|
I have removed references to the schema validation rules. In an ideal world I guess we would be generating this documentation from Pan annotations... |
|
Test PASSed. |
1 similar comment
|
Test PASSed. |
|
@jrha - I think the types change sufficiently infrequently that it's not a problem to include it, although as you say, ideally this should come from PAN. I am OK with merging this. |
|
Test PASSed. |
|
As I mentioned at the stand-up yesterday, I won't merge my own PR, so when everyone is happy please merge! |
|
I thought I did it! |
Fixes all documentation issues open against
configuration-modules-coreforncm-cdp,ncm-ccmandncm-altlogrotate.