From 6ea66bbdff1cc0356c121d453857ecb9d3c1e351 Mon Sep 17 00:00:00 2001
From: Frank Duncan <frank@consxy.com>
Date: Sat, 8 Jan 2022 15:44:53 -0600
Subject: [PATCH] Migrate from github to consxy

---
 README.md           |  2 +-
 bin/buildRelease.sh |  2 +-
 bin/generatedocs.sh |  2 +-
 docs/Changelog.md   | 20 ++++++++++++
 docs/Reference.md   | 78 +++++++++++++++++++++++++++++++++++++++++++++
 5 files changed, 101 insertions(+), 3 deletions(-)
 create mode 100644 docs/Changelog.md
 create mode 100644 docs/Reference.md

diff --git a/README.md b/README.md
index 0707073..b7e06ac 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
 # Common Lisp Style Checker
 Enforcement of my guidelines for common lisp style.
 
-If you like, you can [download it](https://github.com/frankduncan/wolf/releases/download/0.1/wolf_0.1.tar.gz)
+If you like, you can [download it](https://consxy.com/wolf/releases/0.1/style-checker_0.1.tar.gz)
 
 ## Syntax Checking Rules
 * Elements on new line in each form must be indented the same amount
diff --git a/bin/buildRelease.sh b/bin/buildRelease.sh
index 1d6161b..6323397 100755
--- a/bin/buildRelease.sh
+++ b/bin/buildRelease.sh
@@ -10,4 +10,4 @@ cp -ap src/main/* wolf_$version/
 tar zcf wolf_${version}.tar.gz wolf_$version/
 rm -rf wolf_$version
 
-echo "All done, it's in wolf_${version}.tar.gz, you should tag it and push it up to github"
+echo "All done, it's in wolf_${version}.tar.gz, you should tag it and push it up to consxy"
diff --git a/bin/generatedocs.sh b/bin/generatedocs.sh
index 324979a..009d5f6 100755
--- a/bin/generatedocs.sh
+++ b/bin/generatedocs.sh
@@ -5,4 +5,4 @@ sbcl \
   --eval "(asdf:load-system :wolf)" \
   --eval "(format t \"----~%\")" \
   --eval "(format t \"~A\" (sheep:export-package :wolf))" \
-  --eval "(quit)" 2> /dev/null | sed -n '/^----$/,$p' | tail -n +2 > wiki/Home.md
+  --eval "(quit)" 2> /dev/null | sed -n '/^----$/,$p' | tail -n +2 > docs/Reference.md
diff --git a/docs/Changelog.md b/docs/Changelog.md
new file mode 100644
index 0000000..9756e73
--- /dev/null
+++ b/docs/Changelog.md
@@ -0,0 +1,20 @@
+# Changelog
+## [0.1](https://code.consxy.com/gitweb/gitweb.cgi/wolf/commit/0.1)
+* Preparing for release [5dd1203](http://code.consxy.com/gitweb/gitweb.cgi/wolf/5dd1203)
+* Add exception for package.lisp [07a4085](http://code.consxy.com/gitweb/gitweb.cgi/wolf/07a4085)
+* Add pretty printing [3c0f6bb](http://code.consxy.com/gitweb/gitweb.cgi/wolf/3c0f6bb)
+* Add exception for strings [02e9709](http://code.consxy.com/gitweb/gitweb.cgi/wolf/02e9709)
+* Exceptions for comments [c950845](http://code.consxy.com/gitweb/gitweb.cgi/wolf/c950845)
+* Check for multiple spaces in form [243043b](http://code.consxy.com/gitweb/gitweb.cgi/wolf/243043b)
+* Check for indent level in forms [4ce7dfc](http://code.consxy.com/gitweb/gitweb.cgi/wolf/4ce7dfc)
+* Check for spaces/newlines after opening a form [52971da](http://code.consxy.com/gitweb/gitweb.cgi/wolf/52971da)
+* No hanging close parens [7b1e850](http://code.consxy.com/gitweb/gitweb.cgi/wolf/7b1e850)
+* Check that toplevel multiline forms must be separated by a space [659997d](http://code.consxy.com/gitweb/gitweb.cgi/wolf/659997d)
+* Check for internal symbols [1f818db](http://code.consxy.com/gitweb/gitweb.cgi/wolf/1f818db)
+* Check for duplicated empty lines, empty at end of file [1437fe1](http://code.consxy.com/gitweb/gitweb.cgi/wolf/1437fe1)
+* No tabs [7b5c585](http://code.consxy.com/gitweb/gitweb.cgi/wolf/7b5c585)
+* Check whitespace at end of lines [091a882](http://code.consxy.com/gitweb/gitweb.cgi/wolf/091a882)
+* Only one in-package per file [c03906d](http://code.consxy.com/gitweb/gitweb.cgi/wolf/c03906d)
+* Add check for long forms [49f4258](http://code.consxy.com/gitweb/gitweb.cgi/wolf/49f4258)
+* Add long line check [3225bfc](http://code.consxy.com/gitweb/gitweb.cgi/wolf/3225bfc)
+* Add package check [fac9ef1](http://code.consxy.com/gitweb/gitweb.cgi/wolf/fac9ef1)
diff --git a/docs/Reference.md b/docs/Reference.md
new file mode 100644
index 0000000..24fb20d
--- /dev/null
+++ b/docs/Reference.md
@@ -0,0 +1,78 @@
+# Package WOLF
+
+Enforces arbitrary set of style guidelines.
+
+This package walks over common lisp code to make sure it adheres to a set of syntactic guidelines designed to ensure a semblance of uniformity.  No current one was found that could be configured to work the way this one does, so instead of writing a configurable tool, another unconfigurable one was born.
+
+## Contents
+
+* **function [check-directory](#function-check-directory)** - _check-directory_ grabs all .lisp files in the tree under _dir_, and loads checks them all.
+* **function [check-file](#function-check-file)** - _check-file_ runs all the checks against a file and returns as soon as the first style error is found.
+* **function [pretty-print-check-directory](#function-pretty-print-check-directory)** - _pretty-print-check-directory_ checks _dir_ for any errors, dumping them to output and returning a single flag.
+
+## Function **CHECK-DIRECTORY**
+
+#### Syntax:
+
+**check-directory** _dir_ => _results_
+
+```results::= result*```  
+
+#### Arguments and Values:
+
+_dir_---A directory to recurse into and check files  
+_result_---A result as returned by check-file  
+
+#### Description:
+
+_check-directory_ grabs all .lisp files in the tree under _dir_, and loads checks them all.
+
+The results are then put together into a list which can be programatically evaluated.  As opposed to pretty-print-check-directory, this function doesn't clutter up your standard out.
+
+## Function **CHECK-FILE**
+
+#### Syntax:
+
+**check-file** _file_ => _result_
+
+```result::= success-result | failure-result```  
+```success-result::= (:success filename)```  
+```failure-result::= (:success filename msg line-no col-no)```  
+
+#### Arguments and Values:
+
+_file_---a pathname  
+_filename_---the file this check was run on  
+_msg_---a string containing the failure message  
+_line-no_---an integer, the line number on which the failure appeared  
+_col-no_---an integer, the column number on which the failure appeared  
+
+#### Description:
+
+_check-file_ runs all the checks against a file and returns as soon as the first style error is found.
+
+#### Examples:
+
+```(check-file #P"path/to/file.lisp")``` => ```(:success "path/to/file.lisp")```  
+```(check-file #P"path/to/error.lisp")``` => ```(:failure "path/to/error.lisp" "File cannot end with empty line" 20 0)```  
+
+## Function **PRETTY-PRINT-CHECK-DIRECTORY**
+
+#### Syntax:
+
+**pretty-print-check-directory** _dir_ => _success_
+
+#### Arguments and Values:
+
+_dir_---A directory to recurse into and check files  
+_success_---T if there were no failures  
+
+#### Description:
+
+_pretty-print-check-directory_ checks _dir_ for any errors, dumping them to output and returning a single flag.
+
+Unlike check-directory, _pretty-print-check-directory_ is built for continuous integration, dumping errors to standard out and returning a singular result.
+
+#### Examples:
+
+```(pretty-print-check-directory "src")``` => ```nil```  
-- 
2.25.1