geronimo-scm mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jdil...@apache.org
Subject svn commit: r695150 - in /geronimo/gshell/trunk: gshell-api/src/main/java/org/apache/geronimo/gshell/command/ gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/ gshell-support/gshell-event/src/main/resource...
Date Sun, 14 Sep 2008 08:57:01 GMT
Author: jdillon
Date: Sun Sep 14 01:57:00 2008
New Revision: 695150

URL: http://svn.apache.org/viewvc?rev=695150&view=rev
Log:
Added command.manual muck, pending some real docs

Added:
    geronimo/gshell/trunk/gshell-support/gshell-event/src/main/resources/META-INF/
    geronimo/gshell/trunk/gshell-support/gshell-event/src/main/resources/META-INF/spring/
    geronimo/gshell/trunk/gshell-support/gshell-event/src/main/resources/META-INF/spring/components.xml
  (with props)
    geronimo/gshell/trunk/gshell-support/gshell-event/src/test/resources/org/
    geronimo/gshell/trunk/gshell-support/gshell-event/src/test/resources/org/apache/
    geronimo/gshell/trunk/gshell-support/gshell-event/src/test/resources/org/apache/geronimo/
    geronimo/gshell/trunk/gshell-support/gshell-event/src/test/resources/org/apache/geronimo/gshell/
    geronimo/gshell/trunk/gshell-support/gshell-event/src/test/resources/org/apache/geronimo/gshell/event/
Modified:
    geronimo/gshell/trunk/gshell-api/src/main/java/org/apache/geronimo/gshell/command/CommandDocumenter.java
    geronimo/gshell/trunk/gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/ClearCommand.properties
    geronimo/gshell/trunk/gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/EchoCommand.properties
    geronimo/gshell/trunk/gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/ExitCommand.properties
    geronimo/gshell/trunk/gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/HelpCommand.properties
    geronimo/gshell/trunk/gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/SetCommand.properties
    geronimo/gshell/trunk/gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/SourceCommand.properties
    geronimo/gshell/trunk/gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/UnsetCommand.properties
    geronimo/gshell/trunk/gshell-wisdom/gshell-wisdom-core/src/main/java/org/apache/geronimo/gshell/wisdom/command/CommandDocumenterImpl.java

Modified: geronimo/gshell/trunk/gshell-api/src/main/java/org/apache/geronimo/gshell/command/CommandDocumenter.java
URL: http://svn.apache.org/viewvc/geronimo/gshell/trunk/gshell-api/src/main/java/org/apache/geronimo/gshell/command/CommandDocumenter.java?rev=695150&r1=695149&r2=695150&view=diff
==============================================================================
--- geronimo/gshell/trunk/gshell-api/src/main/java/org/apache/geronimo/gshell/command/CommandDocumenter.java
(original)
+++ geronimo/gshell/trunk/gshell-api/src/main/java/org/apache/geronimo/gshell/command/CommandDocumenter.java
Sun Sep 14 01:57:00 2008
@@ -31,18 +31,25 @@
     /**
      * Get the name of the command.
      *
-     * @return The configured name of the command.
+     * @return The name of the command.
      */
     String getName();
 
     /**
      * Get the terse description of the command.
      *
-     * @return The configured description of the command.
+     * @return The description of the command.
      */
     String getDescription();
 
     /**
+     * Get the verbose documentation manual for the command.
+     *
+     * @return  The manual of the command.
+     */
+    String getManual();
+
+    /**
      * Render the command-line usage, as expected from <tt>--help</tt>.
      *
      * @param out   Write the usage to this writer.
@@ -55,8 +62,4 @@
      * @param out   Write the manual to this writer.
      */
     void renderManual(CommandInfo info, PrintWriter out);
-
-    //
-    // TODO: Consider making this a factory, returning a CommandDocumentation for a CommandInfo
-    //
 }
\ No newline at end of file

Modified: geronimo/gshell/trunk/gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/ClearCommand.properties
URL: http://svn.apache.org/viewvc/geronimo/gshell/trunk/gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/ClearCommand.properties?rev=695150&r1=695149&r2=695150&view=diff
==============================================================================
--- geronimo/gshell/trunk/gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/ClearCommand.properties
(original)
+++ geronimo/gshell/trunk/gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/ClearCommand.properties
Sun Sep 14 01:57:00 2008
@@ -23,4 +23,7 @@
 
 command.name=clear
 
-command.description=Clear the terminal screen.
\ No newline at end of file
+command.description=Clear the terminal screen.
+
+command.manual=\
+  TODO: clear manual
\ No newline at end of file

Modified: geronimo/gshell/trunk/gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/EchoCommand.properties
URL: http://svn.apache.org/viewvc/geronimo/gshell/trunk/gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/EchoCommand.properties?rev=695150&r1=695149&r2=695150&view=diff
==============================================================================
--- geronimo/gshell/trunk/gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/EchoCommand.properties
(original)
+++ geronimo/gshell/trunk/gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/EchoCommand.properties
Sun Sep 14 01:57:00 2008
@@ -23,4 +23,7 @@
 
 command.name=echo
 
-command.description=Print arguments to standard output.
\ No newline at end of file
+command.description=Print arguments to standard output.
+
+command.manual=\
+  TODO: echo manual
\ No newline at end of file

Modified: geronimo/gshell/trunk/gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/ExitCommand.properties
URL: http://svn.apache.org/viewvc/geronimo/gshell/trunk/gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/ExitCommand.properties?rev=695150&r1=695149&r2=695150&view=diff
==============================================================================
--- geronimo/gshell/trunk/gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/ExitCommand.properties
(original)
+++ geronimo/gshell/trunk/gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/ExitCommand.properties
Sun Sep 14 01:57:00 2008
@@ -23,4 +23,7 @@
 
 command.name=exit
 
-command.description=Exit the current shell.
\ No newline at end of file
+command.description=Exit the current shell.
+
+command.manual=\
+  TODO: exit manual
\ No newline at end of file

Modified: geronimo/gshell/trunk/gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/HelpCommand.properties
URL: http://svn.apache.org/viewvc/geronimo/gshell/trunk/gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/HelpCommand.properties?rev=695150&r1=695149&r2=695150&view=diff
==============================================================================
--- geronimo/gshell/trunk/gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/HelpCommand.properties
(original)
+++ geronimo/gshell/trunk/gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/HelpCommand.properties
Sun Sep 14 01:57:00 2008
@@ -23,4 +23,7 @@
 
 command.name=help
 
-command.description=Display help for the current context.
\ No newline at end of file
+command.description=Display help for the current context.
+
+command.manual=\
+  TODO: help manual
\ No newline at end of file

Modified: geronimo/gshell/trunk/gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/SetCommand.properties
URL: http://svn.apache.org/viewvc/geronimo/gshell/trunk/gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/SetCommand.properties?rev=695150&r1=695149&r2=695150&view=diff
==============================================================================
--- geronimo/gshell/trunk/gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/SetCommand.properties
(original)
+++ geronimo/gshell/trunk/gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/SetCommand.properties
Sun Sep 14 01:57:00 2008
@@ -23,4 +23,7 @@
 
 command.name=set
 
-command.description=Set a variable or property.
\ No newline at end of file
+command.description=Set a variable or property.
+
+command.manual=\
+  TODO: set manual
\ No newline at end of file

Modified: geronimo/gshell/trunk/gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/SourceCommand.properties
URL: http://svn.apache.org/viewvc/geronimo/gshell/trunk/gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/SourceCommand.properties?rev=695150&r1=695149&r2=695150&view=diff
==============================================================================
--- geronimo/gshell/trunk/gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/SourceCommand.properties
(original)
+++ geronimo/gshell/trunk/gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/SourceCommand.properties
Sun Sep 14 01:57:00 2008
@@ -23,4 +23,7 @@
 
 command.name=source
 
-command.description=Read and execute commands from a file/url in the current shell environment.
\ No newline at end of file
+command.description=Read and execute commands from a file/url in the current shell environment.
+
+command.manual=\
+  TODO: source manual
\ No newline at end of file

Modified: geronimo/gshell/trunk/gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/UnsetCommand.properties
URL: http://svn.apache.org/viewvc/geronimo/gshell/trunk/gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/UnsetCommand.properties?rev=695150&r1=695149&r2=695150&view=diff
==============================================================================
--- geronimo/gshell/trunk/gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/UnsetCommand.properties
(original)
+++ geronimo/gshell/trunk/gshell-commands/gshell-builtins/src/main/resources/org/apache/geronimo/gshell/commands/builtins/UnsetCommand.properties
Sun Sep 14 01:57:00 2008
@@ -23,4 +23,7 @@
 
 command.name=unset
 
-command.description=Unset a variable or property.
\ No newline at end of file
+command.description=Unset a variable or property.
+
+command.manual=\
+  TODO: unset manual
\ No newline at end of file

Added: geronimo/gshell/trunk/gshell-support/gshell-event/src/main/resources/META-INF/spring/components.xml
URL: http://svn.apache.org/viewvc/geronimo/gshell/trunk/gshell-support/gshell-event/src/main/resources/META-INF/spring/components.xml?rev=695150&view=auto
==============================================================================
--- geronimo/gshell/trunk/gshell-support/gshell-event/src/main/resources/META-INF/spring/components.xml
(added)
+++ geronimo/gshell/trunk/gshell-support/gshell-event/src/main/resources/META-INF/spring/components.xml
Sun Sep 14 01:57:00 2008
@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+    Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+-->
+
+<!-- $Rev$ $Date$ -->
+        
+<beans xmlns="http://www.springframework.org/schema/beans"
+       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xmlns:context="http://www.springframework.org/schema/context"
+       xsi:schemaLocation="
+            http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
+            http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-2.5.xsd">
+
+    <context:annotation-config/>
+
+    <!--
+    <bean id="eventManager" class="org.apache.geronimo.gshell.event.EventManagerImpl"/>
+    -->
+
+</beans>
\ No newline at end of file

Propchange: geronimo/gshell/trunk/gshell-support/gshell-event/src/main/resources/META-INF/spring/components.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: geronimo/gshell/trunk/gshell-support/gshell-event/src/main/resources/META-INF/spring/components.xml
------------------------------------------------------------------------------
    svn:executable = *

Propchange: geronimo/gshell/trunk/gshell-support/gshell-event/src/main/resources/META-INF/spring/components.xml
------------------------------------------------------------------------------
    svn:keywords = Date Author Id Revision HeadURL

Propchange: geronimo/gshell/trunk/gshell-support/gshell-event/src/main/resources/META-INF/spring/components.xml
------------------------------------------------------------------------------
    svn:mime-type = text/xml

Modified: geronimo/gshell/trunk/gshell-wisdom/gshell-wisdom-core/src/main/java/org/apache/geronimo/gshell/wisdom/command/CommandDocumenterImpl.java
URL: http://svn.apache.org/viewvc/geronimo/gshell/trunk/gshell-wisdom/gshell-wisdom-core/src/main/java/org/apache/geronimo/gshell/wisdom/command/CommandDocumenterImpl.java?rev=695150&r1=695149&r2=695150&view=diff
==============================================================================
--- geronimo/gshell/trunk/gshell-wisdom/gshell-wisdom-core/src/main/java/org/apache/geronimo/gshell/wisdom/command/CommandDocumenterImpl.java
(original)
+++ geronimo/gshell/trunk/gshell-wisdom/gshell-wisdom-core/src/main/java/org/apache/geronimo/gshell/wisdom/command/CommandDocumenterImpl.java
Sun Sep 14 01:57:00 2008
@@ -41,6 +41,8 @@
 
     private String description;
 
+    private String manual;
+
     public String getName() {
         if (name == null) {
             name = getMessage("command.name");
@@ -63,6 +65,17 @@
         this.description = description;
     }
 
+    public String getManual() {
+        if (manual == null) {
+            manual = getMessage("command.manual");
+        }
+        return manual;
+    }
+
+    public void setManual(final String manual) {
+        this.manual = manual;
+    }
+
     private String getMessage(final String code) {
         assert code != null;
 
@@ -113,10 +126,13 @@
         assert out != null;
 
         log.debug("Rendering command manual");
-        
+
         out.println(info.getName());
         out.println();
-        
-        out.println("TODO: Full docs");
+
+        String manual = getManual();
+
+        out.println(manual);
+        out.println();
     }
 }
\ No newline at end of file



Mime
View raw message