[jira] [Updated] (YETUS-415) shelldocs ability to ignore a file

["Ajay Yadava (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/YETUS-415?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Ajay Yadava updated YETUS-415:
------------------------------
    Attachment: YETUS-415.00.patch

h5. Changes in -00.patch
- shelldocs can now ignore a file based on comment containing "SHELLDOC-IGNORE"
- Added the note in the epilog
- Added it in the documentation on website

h5. How does it work?
Quoting the comments from the code
{quote}
    "SHELLDOC-IGNORE" should either be first line
    or the first line should be a shebang and the second line
    should contain the SHELLDOC-IGNORE in comment.

    A leading '#' and white-spaces(leading or trailing)
    are trimmed before checking equality.

    Comparison is case sensitive and the comment must be in
    UPPERCASE.
{quote}



> shelldocs ability to ignore a file
> ----------------------------------
>
>                 Key: YETUS-415
>                 URL: https://issues.apache.org/jira/browse/YETUS-415
>             Project: Yetus
>          Issue Type: New Feature
>          Components: ShellDocs
>            Reporter: Allen Wittenauer
>            Assignee: Ajay Yadava
>             Fix For: 0.4.0
>
>         Attachments: YETUS-415.00.patch
>
>
> it would be nice if there was a way to tell shelldocs to ignore a file during the parse phase via a comment in the file.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)