mirror of
https://github.com/johnkerl/miller.git
synced 2026-07-17 16:38:54 +00:00
README-go-port.md -> README-dev.md
This commit is contained in:
John Kerl
parent
e1fc3e19c0
commit
ba349fe66f
8 changed files with 21 additions and 33 deletions
|
|
@ -1,10 +1,14 @@
|
|||
# Scope
|
||||
|
||||
This note is for a developer point of view. For a user point of view, please see [https://miller.readthedocs.io/en/latest/new-in-miller-6](https://miller.readthedocs.io/en/latest/new-in-miller-6).
|
||||
|
||||
# Quickstart for developers
|
||||
|
||||
See `makefile` in the repo base directory.
|
||||
* `make`, `make check`, `make docs`, etc: see [Makefile](Makefile) in the repo base directory.
|
||||
* Software-testing methodology: see [./test/README.md](./test/README.md).
|
||||
* Source-code indexing: please see [https://sourcegraph.com/github.com/johnkerl/miller](https://sourcegraph.com/github.com/johnkerl/miller)
|
||||
* Godoc As of September 2021, `godoc` support is minimal: package-level synopses exist; most `func`/`const`/etc content lacks `godoc`-style comments. To view doc material, you can:
|
||||
* `go get golang.org/x/tools/cmd/godoc`
|
||||
* `cd go`
|
||||
* `godoc -http=:6060 -goroot .`
|
||||
* Browse to `http://localhost:6060`
|
||||
* Note: control-C and restart the server, then reload in the browser, to pick up edits to source files
|
||||
|
||||
# Continuous integration
|
||||
|
||||
|
|
@ -180,24 +184,3 @@ In summary:
|
|||
* #779 was a bit more involved, and reveals that Go's elegant goroutine/channel processing model comes with the caveat that channelized data should not be organized in many, small pieces.
|
||||
* #809 was also bit more involved, and reveals that library functions are convenient, but profiling and analysis can sometimes reveal an opportunity for an impact, custom solution.
|
||||
* #786 was a massive refactor involving about 10KLOC -- in hindsight it would have been best to do this work at the start of the Go port, not at the end.
|
||||
|
||||
## Software-testing methodology
|
||||
|
||||
See [./test/README.md](./test/README.md).
|
||||
|
||||
## Godoc
|
||||
|
||||
As of September 2021, `godoc` support is minimal: package-level synopses exist;
|
||||
most `func`/`const`/etc content lacks `godoc`-style comments.
|
||||
|
||||
To view doc material, you can:
|
||||
|
||||
* `go get golang.org/x/tools/cmd/godoc`
|
||||
* `cd go`
|
||||
* `godoc -http=:6060 -goroot .`
|
||||
* Browse to `http://localhost:6060`
|
||||
* Note: control-C and restart the server, then reload in the browser, to pick up edits to source files
|
||||
|
||||
## Source-code indexing
|
||||
|
||||
Please see https://sourcegraph.com/github.com/johnkerl/miller
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
# See also
|
||||
|
||||
* [https://github.com/johnkerl/miller/blob/readme-profiling/README-go-port.md#performance-optimizations](https://github.com/johnkerl/miller/blob/readme-profiling/README-go-port.md#performance-optimizations)
|
||||
* [https://github.com/johnkerl/miller/blob/readme-profiling/README-dev.md#performance-optimizations](https://github.com/johnkerl/miller/blob/readme-profiling/README-dev.md#performance-optimizations)
|
||||
* [https://miller.readthedocs.io/en/latest/new-in-miller-6/#performance-benchmarks](https://miller.readthedocs.io/en/latest/new-in-miller-6/#performance-benchmarks).
|
||||
* `make bench` to run Go benchmarks for Miller
|
||||
|
||||
|
|
|
|||
|
|
@ -107,7 +107,12 @@ See also [building from source](https://miller.readthedocs.io/en/latest/build.ht
|
|||
* To run tests: `go test github.com/johnkerl/miller/internal/pkg/...` and `mlr regtest`.
|
||||
* To install: `go install github.com/johnkerl/miller/cmd/mlr` will install to _GOPATH_`/bin/mlr`.
|
||||
* See also the doc page on [building from source](https://miller.readthedocs.io/en/latest/build).
|
||||
* For more developer information please see [README-go-port.md](./README-go-port.md).
|
||||
* For more developer information please see [README-dev.md](./README-dev.md).
|
||||
|
||||
# For developers
|
||||
|
||||
* [README-dev.md](README-dev.md)
|
||||
* [How to contribute](https://miller.readthedocs.io/en/latest/contributing/)
|
||||
|
||||
# License
|
||||
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@ As of Miller-6's current pre-release status, the best way to test is to either b
|
|||
|
||||
Issues: [https://github.com/johnkerl/miller/issues](https://github.com/johnkerl/miller/issues)
|
||||
|
||||
Developer notes: [https://github.com/johnkerl/miller/blob/main/README-go-port.md](https://github.com/johnkerl/miller/blob/main/README-go-port.md)
|
||||
Developer notes: [https://github.com/johnkerl/miller/blob/main/README-dev.md](https://github.com/johnkerl/miller/blob/main/README-dev.md)
|
||||
|
||||
PRs which pass regression test ([https://github.com/johnkerl/miller/blob/main/test/README.md](https://github.com/johnkerl/miller/blob/main/test/README.md)) are always welcome!
|
||||
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ As of Miller-6's current pre-release status, the best way to test is to either b
|
|||
|
||||
Issues: [https://github.com/johnkerl/miller/issues](https://github.com/johnkerl/miller/issues)
|
||||
|
||||
Developer notes: [https://github.com/johnkerl/miller/blob/main/README-go-port.md](https://github.com/johnkerl/miller/blob/main/README-go-port.md)
|
||||
Developer notes: [https://github.com/johnkerl/miller/blob/main/README-dev.md](https://github.com/johnkerl/miller/blob/main/README-dev.md)
|
||||
|
||||
PRs which pass regression test ([https://github.com/johnkerl/miller/blob/main/test/README.md](https://github.com/johnkerl/miller/blob/main/test/README.md)) are always welcome!
|
||||
|
||||
|
|
|
|||
|
|
@ -345,7 +345,7 @@ for more information.
|
|||
|
||||
## Developer-specific aspects
|
||||
|
||||
* Miller has been ported from C to Go. Developer notes: [https://github.com/johnkerl/miller/blob/main/README-go-port.md](https://github.com/johnkerl/miller/blob/main/README-go-port.md).
|
||||
* Miller has been ported from C to Go. Developer notes: [https://github.com/johnkerl/miller/blob/main/README-dev.md](https://github.com/johnkerl/miller/blob/main/README-dev.md).
|
||||
* Regression testing has been completely reworked, including regression-testing now running fully on Windows (alongside Linux and Mac) [on each GitHub commit](https://github.com/johnkerl/miller/actions).
|
||||
|
||||
## Performance benchmarks
|
||||
|
|
|
|||
|
|
@ -294,7 +294,7 @@ for more information.
|
|||
|
||||
## Developer-specific aspects
|
||||
|
||||
* Miller has been ported from C to Go. Developer notes: [https://github.com/johnkerl/miller/blob/main/README-go-port.md](https://github.com/johnkerl/miller/blob/main/README-go-port.md).
|
||||
* Miller has been ported from C to Go. Developer notes: [https://github.com/johnkerl/miller/blob/main/README-dev.md](https://github.com/johnkerl/miller/blob/main/README-dev.md).
|
||||
* Regression testing has been completely reworked, including regression-testing now running fully on Windows (alongside Linux and Mac) [on each GitHub commit](https://github.com/johnkerl/miller/actions).
|
||||
|
||||
## Performance benchmarks
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
Please see [../../README-go-port.md](../../README-go-port.md) for an overview; please see each subdirectory for details about it.
|
||||
Please see [../../README-dev.md](../../README-dev.md) for an overview; please see each subdirectory for details about it.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue