Skip to content

Commit

Permalink
docs: homogenize top-comment style
Browse files Browse the repository at this point in the history
Add `entities.tcl` copyright information in the readme.
  • Loading branch information
dbohdan committed May 16, 2024
1 parent 7aac0a8 commit dac81f9
Show file tree
Hide file tree
Showing 14 changed files with 37 additions and 28 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
A collection of standalone libraries and a web microframework prototype for [Jim Tcl](http://jim.tcl-lang.org/).
Most of the libraries also work in Tcl 8.5–9.
The libraries implement command-line and proc argument parsing, an HTML DSL, parsing and generating JSON, templates, and persistent storage
powered by SQLite 3.
powered by SQLite 3.
The web microframework provides a rough implementation of the HTTP/1.1 protocol and a routing DSL.

## Components
Expand Down Expand Up @@ -132,5 +132,9 @@ and then pointing your web browser to <http://localhost:8080/>.

MIT.

[entities.tcl](entities.tcl) copyright 1998–2000 Ajuba Solutions and 2006 Michael Schlenker.
It is distributed under the Tcl license.
See the top comment in the file.

`static.jpg` photo by [Steven Lewis](http://notsteve.com/).
License: [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
5 changes: 3 additions & 2 deletions arguments.tcl
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Process command line arguments.
# Copyright (C) 2014, 2015, 2016 dbohdan.
# License: MIT
# Copyright (c) 2014-2016 D. Bohdan.
# License: MIT.

namespace eval ::arguments {
variable version 1.0.0
}
Expand Down
1 change: 1 addition & 0 deletions entities.tcl
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
# authors grant the U.S. Government and others acting in its behalf
# permission to use and distribute the software in accordance with the
# terms specified in this license.

namespace eval ::html {
variable version 1.0.0
}
Expand Down
7 changes: 4 additions & 3 deletions example.tcl
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
#!/usr/bin/env jimsh
# An HTTP server and web framework for Jim Tcl.
# Copyright (C) 2014-2016 D. Bohdan.
#! /usr/bin/env jimsh
# A jimhttp use example.
# Copyright (c) 2014-2016 D. Bohdan.
# License: MIT

source arguments.tcl
source html.tcl
source http.tcl
Expand Down
4 changes: 2 additions & 2 deletions html.tcl
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# An HTML DSL for Jim Tcl.
# Copyright (C) 2014, 2015, 2016 dbohdan.
# License: MIT
# Copyright (c) 2014-2016 D. Bohdan.
# License: MIT.

namespace eval ::html {
variable version 0.2.1
Expand Down
5 changes: 3 additions & 2 deletions http.tcl
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# An HTTP server and web framework for Jim Tcl.
# Copyright (C) 2014, 2015, 2016, 2019 dbohdan.
# License: MIT
# Copyright (c) 2014-2016, 2019 D. Bohdan.
# License: MIT.

namespace eval ::http {
source mime.tcl

Expand Down
2 changes: 1 addition & 1 deletion json.tcl
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# JSON parser/serializer.
# Copyright (c) 2014-2019, 2024 D. Bohdan.
# License: MIT
# License: MIT.
#
# This library is compatible with Tcl 8.5-9 and Jim Tcl 0.76 and later.
# However, to work with unescaped UTF-8 JSON strings
Expand Down
4 changes: 2 additions & 2 deletions mime.tcl
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# MIME type detection by filename extension.
# Copyright (C) 2014, 2015, 2016 dbohdan.
# License: MIT
# Copyright (c) 2014-2016 D. Bohdan.
# License: MIT.

namespace eval ::mime {
variable version 1.2.0
Expand Down
4 changes: 2 additions & 2 deletions rejim.tcl
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# A basic RESP2 Redis/Valkey/KeyDB/etc. client library.
# Pronounced "regime" for some reason.
# Copyright (c) 2019, 2020, 2024 D. Bohdan
# License: MIT
# Copyright (c) 2019-2020, 2024 D. Bohdan.
# License: MIT.

namespace eval rejim {
variable version 0.2.0
Expand Down
4 changes: 2 additions & 2 deletions storage.tcl
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Simple persistent key-value storage.
# Copyright (C) 2014, 2015, 2016 dbohdan.
# License: MIT
# Copyright (c) 2014-2016 D. Bohdan.
# License: MIT.
namespace eval ::storage {
variable version 0.2.0
}
Expand Down
4 changes: 2 additions & 2 deletions template.tcl
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Templating engine.
# Copyright (C) 2014, 2015, 2016 dbohdan.
# License: MIT
# Copyright (c) 2014-2016 D. Bohdan.
# License: MIT.
namespace eval ::template {
variable version 1.0.0
}
Expand Down
8 changes: 4 additions & 4 deletions testing.tcl
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env jimsh
#! /usr/bin/env jimsh
# A test framework with constraints.
# Copyright (C) 2014, 2015, 2016, 2019 dbohdan.
# License: MIT
# Copyright (c) 2014-2016, 2019 D. Bohdan.
# License: MIT.

namespace eval ::testing {
variable version 0.5.0
Expand Down Expand Up @@ -99,7 +99,7 @@ proc ::testing::run-tests argv {
lappend skipped $test {user choice}
continue
}

set unsat [::testing::unsat-constraints $test]
if {$unsat eq {}} {
puts "- $test"
Expand Down
4 changes: 2 additions & 2 deletions tests.tcl
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env jimsh
#! /usr/bin/env jimsh
# Tests for the web framework and its modules.
# Copyright (c) 2014-2016, 2018-2020, 2024 D. Bohdan.
# License: MIT
# License: MIT.

source testing.tcl
namespace import ::testing::*
Expand Down
7 changes: 4 additions & 3 deletions update-readme.tcl
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env jimsh
#! /usr/bin/env jimsh
# Update jimhttp components' versions in README.md.
# Copyright (C) 2015, 2016 dbohdan.
# License: MIT
# Copyright (c) 2015-2016 D. Bohdan.
# License: MIT.

proc read-file filename {
set channel [open $filename]
Expand Down Expand Up @@ -35,4 +35,5 @@ foreach line [split [read-file README.md] \n] {
lappend updatedReadme $line
}
}

write-file README.md [join $updatedReadme \n]

0 comments on commit dac81f9

Please sign in to comment.