aboutsummaryrefslogtreecommitdiff
path: root/awwan.go
diff options
context:
space:
mode:
authorShulhan <ms@kilabit.info>2023-03-17 22:24:06 +0700
committerShulhan <ms@kilabit.info>2023-03-17 22:24:06 +0700
commit42e96adf2ea2bab6f173bd38eed49f30346867dd (patch)
tree6d398000ba1b6302f9730db1315724046f30f5c4 /awwan.go
parentcc59d3e765acd364376f5f7df143d318ca23f8c8 (diff)
downloadawwan-42e96adf2ea2bab6f173bd38eed49f30346867dd.tar.xz
all: fix and add comments to global constants and methods
This mark the development for the next minor version.
Diffstat (limited to 'awwan.go')
-rw-r--r--awwan.go10
1 files changed, 8 insertions, 2 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"