From 42e96adf2ea2bab6f173bd38eed49f30346867dd Mon Sep 17 00:00:00 2001 From: Shulhan Date: Fri, 17 Mar 2023 22:24:06 +0700 Subject: all: fix and add comments to global constants and methods This mark the development for the next minor version. --- awwan.go | 10 ++++++++-- statement.go | 2 +- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/awwan.go b/awwan.go index 3c7efe8..1f60222 100644 --- a/awwan.go +++ b/awwan.go @@ -21,14 +21,18 @@ import ( "github.com/shuLhan/share/lib/ssh/config" ) -const ( - Version = `0.6.2` +// Version current version of this module (library and program). +const Version = `0.7.0-dev` +// List of command available for program awwan. +const ( CommandModeBuild = "build" CommandModeLocal = "local" CommandModePlay = "play" CommandModeServe = "serve" +) +const ( defCacheDir = ".cache" defEnvFileName = "awwan.env" // The default awwan environment file name. defListenAddress = "127.0.0.1:17600" @@ -127,6 +131,7 @@ func (aww *Awwan) Build() (err error) { return nil } +// Local execute the script in the local machine using shell. func (aww *Awwan) Local(req *Request) (err error) { var ( logp = "Local" @@ -194,6 +199,7 @@ func (aww *Awwan) Local(req *Request) (err error) { return nil } +// Play execute the script in the remote machine using SSH. func (aww *Awwan) Play(req *Request) (err error) { var ( logp = "Play" diff --git a/statement.go b/statement.go index 87b3a5b..84071dd 100644 --- a/statement.go +++ b/statement.go @@ -21,7 +21,7 @@ const ( statementKindSudoPut ) -// Statetement contains parsed raw line from the script. +// Statement contains parsed raw line from the script. type Statement struct { cmd string args []string -- cgit v1.3