You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@uima.apache.org by "Eddie Epstein (JIRA)" <ui...@incubator.apache.org> on 2007/04/13 15:38:15 UTC

[jira] Created: (UIMA-373) UIMA's Unix command line utilities are named badly

UIMA's Unix command line utilities are named badly
--------------------------------------------------

                 Key: UIMA-373
                 URL: https://issues.apache.org/jira/browse/UIMA-373
             Project: UIMA
          Issue Type: Improvement
          Components: Core Java Framework
         Environment: Unix
            Reporter: Eddie Epstein


UIMA command line utilities are available in two flavors: commandName.bat for Windows and commandName.sh for Unix. The Unix world typically does not use an extension for scripts.

In addition to looking dumb, my real peeve with the .sh extension is how it complicates writing documentation, saying things like "using the cpeGui shell script (cpeGui.bat on Windows, cpeGui.sh on Unix)". Dropping .sh would allow the documentation to just say "using commandName".

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Reopened: (UIMA-373) UIMA's Unix command line utilities are named badly

Posted by "Marshall Schor (JIRA)" <ui...@incubator.apache.org>.
     [ https://issues.apache.org/jira/browse/UIMA-373?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Marshall Schor reopened UIMA-373:
---------------------------------


to change resolution, only

> UIMA's Unix command line utilities are named badly
> --------------------------------------------------
>
>                 Key: UIMA-373
>                 URL: https://issues.apache.org/jira/browse/UIMA-373
>             Project: UIMA
>          Issue Type: Improvement
>          Components: Core Java Framework
>         Environment: Unix
>            Reporter: Eddie Epstein
>            Priority: Minor
>
> UIMA command line utilities are available in two flavors: commandName.bat for Windows and commandName.sh for Unix. The Unix world typically does not use an extension for scripts.
> In addition to looking dumb, my real peeve with the .sh extension is how it complicates writing documentation, saying things like "using the cpeGui shell script (cpeGui.bat on Windows, cpeGui.sh on Unix)". Dropping .sh would allow the documentation to just say "using commandName".

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (UIMA-373) UIMA's Unix command line utilities are named badly

Posted by "Adam Lally (JIRA)" <ui...@incubator.apache.org>.
    [ https://issues.apache.org/jira/browse/UIMA-373?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12488697 ] 

Adam Lally commented on UIMA-373:
---------------------------------

Can we have both?  I wouldn't want to disorient our users who had gotten used to the .sh versions.  The extension-less command could just call the .sh version (or vice-versa) so there wouldn't have to be duplicate files to maintain.  A symbolic link might be better, but I'm not sure how to do that and maintain a platform-independent built process.

> UIMA's Unix command line utilities are named badly
> --------------------------------------------------
>
>                 Key: UIMA-373
>                 URL: https://issues.apache.org/jira/browse/UIMA-373
>             Project: UIMA
>          Issue Type: Improvement
>          Components: Core Java Framework
>         Environment: Unix
>            Reporter: Eddie Epstein
>
> UIMA command line utilities are available in two flavors: commandName.bat for Windows and commandName.sh for Unix. The Unix world typically does not use an extension for scripts.
> In addition to looking dumb, my real peeve with the .sh extension is how it complicates writing documentation, saying things like "using the cpeGui shell script (cpeGui.bat on Windows, cpeGui.sh on Unix)". Dropping .sh would allow the documentation to just say "using commandName".

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (UIMA-373) UIMA's Unix command line utilities are named badly

Posted by "Thilo Goetz (JIRA)" <ui...@incubator.apache.org>.
    [ https://issues.apache.org/jira/browse/UIMA-373?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12488682 ] 

Thilo Goetz commented on UIMA-373:
----------------------------------

Many people do in fact use .sh as script file extension, and it is considered a best practice by some.  I don't personally like files without extensions very much, as it's even harder to know what they are.

Don't you think we can expect our users to make the leap from "cpeGui shell script" cpeGui.bat or cpeGui.sh, depending on the platform?  I think users who don't manage to make that connection by themselves will have a very hard time with the rest of UIMA.  And while we're on the topic of "typically": command names typically don't use camel case.  So there ;-)

> UIMA's Unix command line utilities are named badly
> --------------------------------------------------
>
>                 Key: UIMA-373
>                 URL: https://issues.apache.org/jira/browse/UIMA-373
>             Project: UIMA
>          Issue Type: Improvement
>          Components: Core Java Framework
>         Environment: Unix
>            Reporter: Eddie Epstein
>
> UIMA command line utilities are available in two flavors: commandName.bat for Windows and commandName.sh for Unix. The Unix world typically does not use an extension for scripts.
> In addition to looking dumb, my real peeve with the .sh extension is how it complicates writing documentation, saying things like "using the cpeGui shell script (cpeGui.bat on Windows, cpeGui.sh on Unix)". Dropping .sh would allow the documentation to just say "using commandName".

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Closed: (UIMA-373) UIMA's Unix command line utilities are named badly

Posted by "Marshall Schor (JIRA)" <ui...@incubator.apache.org>.
     [ https://issues.apache.org/jira/browse/UIMA-373?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Marshall Schor closed UIMA-373.
-------------------------------

    Resolution: Won't Fix

> UIMA's Unix command line utilities are named badly
> --------------------------------------------------
>
>                 Key: UIMA-373
>                 URL: https://issues.apache.org/jira/browse/UIMA-373
>             Project: UIMA
>          Issue Type: Improvement
>          Components: Core Java Framework
>         Environment: Unix
>            Reporter: Eddie Epstein
>            Priority: Minor
>
> UIMA command line utilities are available in two flavors: commandName.bat for Windows and commandName.sh for Unix. The Unix world typically does not use an extension for scripts.
> In addition to looking dumb, my real peeve with the .sh extension is how it complicates writing documentation, saying things like "using the cpeGui shell script (cpeGui.bat on Windows, cpeGui.sh on Unix)". Dropping .sh would allow the documentation to just say "using commandName".

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (UIMA-373) UIMA's Unix command line utilities are named badly

Posted by "Eddie Epstein (JIRA)" <ui...@incubator.apache.org>.
     [ https://issues.apache.org/jira/browse/UIMA-373?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Eddie Epstein updated UIMA-373:
-------------------------------

    Priority: Minor  (was: Major)

Given the initial reaction, the priority has been dropped to "Minor". If nobody buys this suit in the next week, the priority will be dropped to "Trivial", and then, if still unsold a week later, this issue will be removed from Jira and sent back to the factory to be recycled.

> UIMA's Unix command line utilities are named badly
> --------------------------------------------------
>
>                 Key: UIMA-373
>                 URL: https://issues.apache.org/jira/browse/UIMA-373
>             Project: UIMA
>          Issue Type: Improvement
>          Components: Core Java Framework
>         Environment: Unix
>            Reporter: Eddie Epstein
>            Priority: Minor
>
> UIMA command line utilities are available in two flavors: commandName.bat for Windows and commandName.sh for Unix. The Unix world typically does not use an extension for scripts.
> In addition to looking dumb, my real peeve with the .sh extension is how it complicates writing documentation, saying things like "using the cpeGui shell script (cpeGui.bat on Windows, cpeGui.sh on Unix)". Dropping .sh would allow the documentation to just say "using commandName".

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Closed: (UIMA-373) UIMA's Unix command line utilities are named badly

Posted by "Eddie Epstein (JIRA)" <ui...@incubator.apache.org>.
     [ https://issues.apache.org/jira/browse/UIMA-373?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Eddie Epstein closed UIMA-373.
------------------------------

    Resolution: Fixed

Should have closed this long ago.

> UIMA's Unix command line utilities are named badly
> --------------------------------------------------
>
>                 Key: UIMA-373
>                 URL: https://issues.apache.org/jira/browse/UIMA-373
>             Project: UIMA
>          Issue Type: Improvement
>          Components: Core Java Framework
>         Environment: Unix
>            Reporter: Eddie Epstein
>            Priority: Minor
>
> UIMA command line utilities are available in two flavors: commandName.bat for Windows and commandName.sh for Unix. The Unix world typically does not use an extension for scripts.
> In addition to looking dumb, my real peeve with the .sh extension is how it complicates writing documentation, saying things like "using the cpeGui shell script (cpeGui.bat on Windows, cpeGui.sh on Unix)". Dropping .sh would allow the documentation to just say "using commandName".

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.