From abf02e9e0db78c39f72049d044f9a44444b45bdd Mon Sep 17 00:00:00 2001 From: mleku Date: Sun, 2 Feb 2025 18:38:57 -0106 Subject: [PATCH] switch all the things to asciidoc --- clients/readme.adoc | 3 +++ clients/readme.md | 3 --- pkg/lol/{readme.md => readme.adoc} | 30 ++++++++++++++++-------------- pkg/readme.adoc | 3 +++ pkg/readme.md | 3 --- relays/readme.adoc | 3 +++ relays/readme.md | 3 --- repos/readme.adoc | 3 +++ repos/readme.md | 3 --- 9 files changed, 28 insertions(+), 26 deletions(-) create mode 100644 clients/readme.adoc delete mode 100644 clients/readme.md rename pkg/lol/{readme.md => readme.adoc} (69%) create mode 100644 pkg/readme.adoc delete mode 100644 pkg/readme.md create mode 100644 relays/readme.adoc delete mode 100644 relays/readme.md create mode 100644 repos/readme.adoc delete mode 100644 repos/readme.md diff --git a/clients/readme.adoc b/clients/readme.adoc new file mode 100644 index 0000000..c41d0a6 --- /dev/null +++ b/clients/readme.adoc @@ -0,0 +1,3 @@ += clients + +here be some reference clients for various sub-protocols \ No newline at end of file diff --git a/clients/readme.md b/clients/readme.md deleted file mode 100644 index eeb7776..0000000 --- a/clients/readme.md +++ /dev/null @@ -1,3 +0,0 @@ -# clients - -here be some reference clients for various sub-protocols \ No newline at end of file diff --git a/pkg/lol/readme.md b/pkg/lol/readme.adoc similarity index 69% rename from pkg/lol/readme.md rename to pkg/lol/readme.adoc index afd1fa5..d595782 100644 --- a/pkg/lol/readme.md +++ b/pkg/lol/readme.adoc @@ -1,35 +1,37 @@ -# lol += lol location of log This is a very simple, but practical library for logging in applications. Its main feature is printing source code locations to make debugging easier. -## usage +== usage put this somewhere in your package: -```go +[source,go] +---- var log, chk, errorf = lol.Main.Log, lol.Main.Check, lol.Main.Errorf -``` +---- then you can invoke like this: -```go +[source,go] +---- log.I.S(spew.this.thing) errorf.E("print and return this error") if err = bogus; chk.E(err) { return bogus.response } // print an error at the site and return the error -``` +---- -## terminals +== terminals -Due to how so few terminals actually support source location hyperlinks, pretty much tilix and intellij terminal are -the only two that really provide adequate functionality, this logging library defaults to output format that works -best with intellij. As such, the terminal is aware of the CWD and the code locations printed are relative, as -required to get the hyperlinkization from this terminal. Handling support for Tilix requires more complications and -due to advances with IntelliJ's handling it is not practical to support any other for this purpose. Users of this +Due to how so few terminals actually support source location hyperlinks, pretty much tilix and intellij terminal are +the only two that really provide adequate functionality, this logging library defaults to output format that works +best with intellij. As such, the terminal is aware of the CWD and the code locations printed are relative, as +required to get the hyperlinkization from this terminal. Handling support for Tilix requires more complications and +due to advances with IntelliJ's handling it is not practical to support any other for this purpose. Users of this library can always fall back to manually interpreting and accessing the relative file path to find the source of a log. -In addition, due to this terminal's slow rendering of long lines, long log strings are automatically broken into 80 -character lines, and if there is comma separators in the line, the line is broken at the comma instead of at +In addition, due to this terminal's slow rendering of long lines, long log strings are automatically broken into 80 +character lines, and if there is comma separators in the line, the line is broken at the comma instead of at column80. This works perfectly for this purpose. \ No newline at end of file diff --git a/pkg/readme.adoc b/pkg/readme.adoc new file mode 100644 index 0000000..afbb1fd --- /dev/null +++ b/pkg/readme.adoc @@ -0,0 +1,3 @@ += pkg + +go libraries shared by clients and relays \ No newline at end of file diff --git a/pkg/readme.md b/pkg/readme.md deleted file mode 100644 index 7986fbe..0000000 --- a/pkg/readme.md +++ /dev/null @@ -1,3 +0,0 @@ -# pkg - -go libraries shared by clients and relays \ No newline at end of file diff --git a/relays/readme.adoc b/relays/readme.adoc new file mode 100644 index 0000000..4314016 --- /dev/null +++ b/relays/readme.adoc @@ -0,0 +1,3 @@ += relays + +relay implementations for various subprotocols \ No newline at end of file diff --git a/relays/readme.md b/relays/readme.md deleted file mode 100644 index 4f8f4c0..0000000 --- a/relays/readme.md +++ /dev/null @@ -1,3 +0,0 @@ -# relays - -relay implementations for various subprotocols \ No newline at end of file diff --git a/repos/readme.adoc b/repos/readme.adoc new file mode 100644 index 0000000..4314016 --- /dev/null +++ b/repos/readme.adoc @@ -0,0 +1,3 @@ += relays + +relay implementations for various subprotocols \ No newline at end of file diff --git a/repos/readme.md b/repos/readme.md deleted file mode 100644 index 4f8f4c0..0000000 --- a/repos/readme.md +++ /dev/null @@ -1,3 +0,0 @@ -# relays - -relay implementations for various subprotocols \ No newline at end of file