pkgsrc-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
[pkgsrc/trunk]: pkgsrc Fix formatting of go DESCR files. Some of the content...
details: https://anonhg.NetBSD.org/pkgsrc/rev/59b80206c852
branches: trunk
changeset: 367189:59b80206c852
user: jperkin <jperkin%pkgsrc.org@localhost>
date: Fri Aug 25 16:30:23 2017 +0000
description:
Fix formatting of go DESCR files. Some of the contents still leave a lot to be
desired.
diffstat:
databases/go-etcd/DESCR | 4 +++-
devel/go-afero/DESCR | 18 ++++++++++++++----
devel/go-amber/DESCR | 3 ++-
devel/go-blackfriday/DESCR | 8 ++++++--
devel/go-buffruneio/DESCR | 3 ++-
devel/go-cast/DESCR | 2 --
devel/go-cobra/DESCR | 3 ++-
devel/go-consul-api/DESCR | 3 ++-
devel/go-errors/DESCR | 5 ++++-
devel/go-gitmap/DESCR | 7 +++++--
devel/go-golang-lru/DESCR | 3 ++-
devel/go-goorgeous/DESCR | 7 +++++--
devel/go-homedir/DESCR | 13 ++++++++++---
devel/go-i18n/DESCR | 15 ++++++++-------
devel/go-immutable-radix/DESCR | 14 +++++++++-----
devel/go-jwalterweatherman/DESCR | 16 ++++++++++------
devel/go-mapstructure/DESCR | 9 +++++++--
devel/go-nitro/DESCR | 4 +++-
devel/go-osext/DESCR | 6 +++++-
devel/go-pflag/DESCR | 10 +++++++---
devel/go-properties/DESCR | 17 +++++++++++++----
devel/go-purell/DESCR | 3 ++-
devel/go-sanitized_anchor_name/DESCR | 6 ++++--
devel/go-shuffle/DESCR | 3 ++-
lang/go-hcl/DESCR | 9 +++++++--
math/go-stats/DESCR | 7 +++----
net/go-websocket/DESCR | 3 ++-
security/go-sftp/DESCR | 3 ++-
textproc/go-md2man/DESCR | 4 ++--
textproc/go-mmark/DESCR | 4 +++-
textproc/go-prose/DESCR | 5 ++++-
www/go-ace/DESCR | 3 ++-
www/go-gohtml/DESCR | 3 ++-
www/go-toml-burntsushi/DESCR | 6 +++++-
www/go-toml-pelletier/DESCR | 6 +++++-
35 files changed, 164 insertions(+), 71 deletions(-)
diffs (truncated from 448 to 300 lines):
diff -r 72745221b2fc -r 59b80206c852 databases/go-etcd/DESCR
--- a/databases/go-etcd/DESCR Fri Aug 25 16:06:44 2017 +0000
+++ b/databases/go-etcd/DESCR Fri Aug 25 16:30:23 2017 +0000
@@ -2,4 +2,6 @@
etcd now has an official Go client, which has a nicer API and better support.
-We strongly suggest you use the official Go client instead of go-etcd in your new projects. For existing projects, we suggest you migrate to the official Go client.
+We strongly suggest you use the official Go client instead of go-etcd in your
+new projects. For existing projects, we suggest you migrate to the official Go
+client.
diff -r 72745221b2fc -r 59b80206c852 devel/go-afero/DESCR
--- a/devel/go-afero/DESCR Fri Aug 25 16:06:44 2017 +0000
+++ b/devel/go-afero/DESCR Fri Aug 25 16:30:23 2017 +0000
@@ -1,7 +1,17 @@
-Afero is an filesystem framework providing a simple, uniform and universal API interacting with any filesystem, as an abstraction layer providing interfaces, types and methods. Afero has an
exceptionally clean interface and simple design without needless constructors or initialization methods.
+Afero is an filesystem framework providing a simple, uniform and universal API
+interacting with any filesystem, as an abstraction layer providing interfaces,
+types and methods. Afero has an exceptionally clean interface and simple design
+without needless constructors or initialization methods.
-Afero is also a library providing a base set of interoperable backend filesystems that make it easy to work with afero while retaining all the power and benefit of the os and ioutil packages.
+Afero is also a library providing a base set of interoperable backend
+filesystems that make it easy to work with afero while retaining all the power
+and benefit of the os and ioutil packages.
-Afero provides significant improvements over using the os package alone, most notably the ability to create mock and testing filesystems without relying on the disk.
+Afero provides significant improvements over using the os package alone, most
+notably the ability to create mock and testing filesystems without relying on
+the disk.
-It is suitable for use in a any situation where you would consider using the OS package as it provides an additional abstraction that makes it easy to use a memory backed file system during testing.
It also adds support for the http filesystem for full interoperability.
+It is suitable for use in a any situation where you would consider using the OS
+package as it provides an additional abstraction that makes it easy to use a
+memory backed file system during testing. It also adds support for the http
+filesystem for full interoperability.
diff -r 72745221b2fc -r 59b80206c852 devel/go-amber/DESCR
--- a/devel/go-amber/DESCR Fri Aug 25 16:06:44 2017 +0000
+++ b/devel/go-amber/DESCR Fri Aug 25 16:30:23 2017 +0000
@@ -1,1 +1,2 @@
-Amber is an elegant templating engine for Go Programming Language It is inspired from HAML and Jade
+Amber is an elegant templating engine for Go Programming Language. It is
+inspired from HAML and Jade
diff -r 72745221b2fc -r 59b80206c852 devel/go-blackfriday/DESCR
--- a/devel/go-blackfriday/DESCR Fri Aug 25 16:06:44 2017 +0000
+++ b/devel/go-blackfriday/DESCR Fri Aug 25 16:30:23 2017 +0000
@@ -1,5 +1,9 @@
-Blackfriday is a Markdown processor implemented in Go. It is paranoid about its input (so you can safely feed it user-supplied data), it is fast, it supports common extensions (tables, smart
punctuation substitutions, etc.), and it is safe for all utf-8 (unicode) input.
+Blackfriday is a Markdown processor implemented in Go. It is paranoid about its
+input (so you can safely feed it user-supplied data), it is fast, it supports
+common extensions (tables, smart punctuation substitutions, etc.), and it is
+safe for all utf-8 (unicode) input.
-HTML output is currently supported, along with Smartypants extensions. An experimental LaTeX output engine is also included.
+HTML output is currently supported, along with Smartypants extensions. An
+experimental LaTeX output engine is also included.
It started as a translation from C of Sundown.
diff -r 72745221b2fc -r 59b80206c852 devel/go-buffruneio/DESCR
--- a/devel/go-buffruneio/DESCR Fri Aug 25 16:06:44 2017 +0000
+++ b/devel/go-buffruneio/DESCR Fri Aug 25 16:30:23 2017 +0000
@@ -1,1 +1,2 @@
-Buffruneio is a wrapper around bufio to provide buffered runes access with unlimited unreads.
+Buffruneio is a wrapper around bufio to provide buffered runes access with
+unlimited unreads.
diff -r 72745221b2fc -r 59b80206c852 devel/go-cast/DESCR
--- a/devel/go-cast/DESCR Fri Aug 25 16:06:44 2017 +0000
+++ b/devel/go-cast/DESCR Fri Aug 25 16:30:23 2017 +0000
@@ -1,3 +1,1 @@
Easy and safe casting from one type to another in Go
-
-Donâ??t Panic! ... Cast
diff -r 72745221b2fc -r 59b80206c852 devel/go-cobra/DESCR
--- a/devel/go-cobra/DESCR Fri Aug 25 16:06:44 2017 +0000
+++ b/devel/go-cobra/DESCR Fri Aug 25 16:30:23 2017 +0000
@@ -1,1 +1,2 @@
-Cobra is both a library for creating powerful modern CLI applications as well as a program to generate applications and command files.
+Cobra is both a library for creating powerful modern CLI applications as well
+as a program to generate applications and command files.
diff -r 72745221b2fc -r 59b80206c852 devel/go-consul-api/DESCR
--- a/devel/go-consul-api/DESCR Fri Aug 25 16:06:44 2017 +0000
+++ b/devel/go-consul-api/DESCR Fri Aug 25 16:30:23 2017 +0000
@@ -1,3 +1,4 @@
-This package provides the consulapi package which attempts to provide programmatic access to the full Consul API.
+This package provides the consulapi package which attempts to provide
+programmatic access to the full Consul API.
Currently, all of the Consul APIs included in version 0.4 are supported.
diff -r 72745221b2fc -r 59b80206c852 devel/go-errors/DESCR
--- a/devel/go-errors/DESCR Fri Aug 25 16:06:44 2017 +0000
+++ b/devel/go-errors/DESCR Fri Aug 25 16:30:23 2017 +0000
@@ -6,4 +6,7 @@
return err
}
-which applied recursively up the call stack results in error reports without context or debugging information. The errors package allows programmers to add context to the failure path in their code
in a way that does not destroy the original value of the error.
+which applied recursively up the call stack results in error reports without
+context or debugging information. The errors package allows programmers to add
+context to the failure path in their code in a way that does not destroy the
+original value of the error.
diff -r 72745221b2fc -r 59b80206c852 devel/go-gitmap/DESCR
--- a/devel/go-gitmap/DESCR Fri Aug 25 16:06:44 2017 +0000
+++ b/devel/go-gitmap/DESCR Fri Aug 25 16:30:23 2017 +0000
@@ -1,3 +1,6 @@
-A fairly fast way to create a map from all the filenames to info objects for a given revision of a Git repo.
+A fairly fast way to create a map from all the filenames to info objects for a
+given revision of a Git repo.
-This library uses os/exec to talk to Git. There are faster ways to do this by using some Go Git-lib or C bindings, but that adds dependencies I really don't want or need.
+This library uses os/exec to talk to Git. There are faster ways to do this by
+using some Go Git-lib or C bindings, but that adds dependencies I really don't
+want or need.
diff -r 72745221b2fc -r 59b80206c852 devel/go-golang-lru/DESCR
--- a/devel/go-golang-lru/DESCR Fri Aug 25 16:06:44 2017 +0000
+++ b/devel/go-golang-lru/DESCR Fri Aug 25 16:30:23 2017 +0000
@@ -1,1 +1,2 @@
-This provides the lru package which implements a fixed-size thread safe LRU cache. It is based on the cache in Groupcache.
+This provides the lru package which implements a fixed-size thread safe LRU
+cache. It is based on the cache in Groupcache.
diff -r 72745221b2fc -r 59b80206c852 devel/go-goorgeous/DESCR
--- a/devel/go-goorgeous/DESCR Fri Aug 25 16:06:44 2017 +0000
+++ b/devel/go-goorgeous/DESCR Fri Aug 25 16:30:23 2017 +0000
@@ -2,7 +2,10 @@
Pronounced: Go? Org? Yes!
- "Org mode is for keeping notes, maintaining TODO lists, planning projects, and authoring documents with a fast and effective plain-text system."
+ "Org mode is for keeping notes, maintaining TODO lists, planning projects,
+ and authoring documents with a fast and effective plain-text system."
orgmode.org
-The purpose of this package is to come as close as possible as parsing an *.org document into HTML, the same way one might publish with org-publish-html from Emacs.
+The purpose of this package is to come as close as possible as parsing an
+*.org document into HTML, the same way one might publish with org-publish-html
+from Emacs.
diff -r 72745221b2fc -r 59b80206c852 devel/go-homedir/DESCR
--- a/devel/go-homedir/DESCR Fri Aug 25 16:06:44 2017 +0000
+++ b/devel/go-homedir/DESCR Fri Aug 25 16:30:23 2017 +0000
@@ -1,5 +1,12 @@
-This is a Go library for detecting the user's home directory without the use of cgo, so the library can be used in cross-compilation environments.
+This is a Go library for detecting the user's home directory without the use of
+cgo, so the library can be used in cross-compilation environments.
-Usage is incredibly simple, just call homedir.Dir() to get the home directory for a user, and homedir.Expand() to expand the ~ in a path to the home directory.
+Usage is incredibly simple, just call homedir.Dir() to get the home directory
+for a user, and homedir.Expand() to expand the ~ in a path to the home
+directory.
-Why not just use os/user? The built-in os/user package requires cgo on Darwin systems. This means that any Go code that uses that package cannot cross compile. But 99% of the time the use for
os/user is just to retrieve the home directory, which we can do for the current user without cgo. This library does that, enabling cross-compilation.
+Why not just use os/user? The built-in os/user package requires cgo on Darwin
+systems. This means that any Go code that uses that package cannot cross
+compile. But 99% of the time the use for os/user is just to retrieve the home
+directory, which we can do for the current user without cgo. This library does
+that, enabling cross-compilation.
diff -r 72745221b2fc -r 59b80206c852 devel/go-i18n/DESCR
--- a/devel/go-i18n/DESCR Fri Aug 25 16:06:44 2017 +0000
+++ b/devel/go-i18n/DESCR Fri Aug 25 16:30:23 2017 +0000
@@ -1,8 +1,9 @@
-go-i18n is a Go package and a command that helps you translate Go programs into multiple languages.
+go-i18n is a Go package and a command that helps you translate Go programs into
+multiple languages.
- Supports pluralized strings for all 200+ languages in the Unicode Common Locale Data Repository (CLDR).
- Code and tests are automatically generated from CLDR data
- Supports strings with named variables using text/template syntax.
- Translation files are simple JSON, TOML or YAML.
- Documented and tested!
-
+ * Supports pluralized strings for all 200+ languages in the Unicode Common
+ Locale Data Repository (CLDR).
+ * Code and tests are automatically generated from CLDR data
+ * Supports strings with named variables using text/template syntax.
+ * Translation files are simple JSON, TOML or YAML.
+ * Documented and tested!
diff -r 72745221b2fc -r 59b80206c852 devel/go-immutable-radix/DESCR
--- a/devel/go-immutable-radix/DESCR Fri Aug 25 16:06:44 2017 +0000
+++ b/devel/go-immutable-radix/DESCR Fri Aug 25 16:30:23 2017 +0000
@@ -1,11 +1,15 @@
-Provides the iradix package that implements an immutable radix tree. The package only provides a single Tree implementation, optimized for sparse nodes.
+Provides the iradix package that implements an immutable radix tree. The
+package only provides a single Tree implementation, optimized for sparse nodes.
As a radix tree, it provides the following:
- O(k) operations. In many cases, this can be faster than a hash table since the hash function is an O(k) operation, and hash tables have very poor cache locality.
- Minimum / Maximum value lookups
- Ordered iteration
+ * O(k) operations. In many cases, this can be faster than a hash table since
+ the hash function is an O(k) operation, and hash tables have very poor cache
+ locality.
+ * Minimum / Maximum value lookups
+ * Ordered iteration
-A tree supports using a transaction to batch multiple updates (insert, delete) in a more efficient manner than performing each operation one at a time.
+A tree supports using a transaction to batch multiple updates (insert, delete)
+in a more efficient manner than performing each operation one at a time.
For a mutable variant, see go-radix.
diff -r 72745221b2fc -r 59b80206c852 devel/go-jwalterweatherman/DESCR
--- a/devel/go-jwalterweatherman/DESCR Fri Aug 25 16:06:44 2017 +0000
+++ b/devel/go-jwalterweatherman/DESCR Fri Aug 25 16:30:23 2017 +0000
@@ -1,19 +1,23 @@
jWalterWeatherman
-Seamless printing to the terminal (stdout) and logging to a io.Writer (file) thatâ??s as easy to use as fmt.Println.
+Seamless printing to the terminal (stdout) and logging to a io.Writer (file)
+that's as easy to use as fmt.Println.
-JWW is primarily a wrapper around the excellent standard log library. It provides a few advantages over using the standard log library alone.
+JWW is primarily a wrapper around the excellent standard log library. It
+provides a few advantages over using the standard log library alone.
1. Ready to go out of the box.
2. One library for both printing to the terminal and logging (to files).
3. Really easy to log to either a temp file or a file you specify.
-I really wanted a very straightforward library that could seamlessly do the following things.
+I really wanted a very straightforward library that could seamlessly do the
+following things.
-1. Replace all the println, printf, etc statements thought my code with something more useful
+1. Replace all the println, printf, etc statements thought my code with
+ something more useful
2. Allow the user to easily control what levels are printed to stdout
3. Allow the user to easily control what levels are logged
-4. Provide an easy mechanism (like fmt.Println) to print info to the user which can be easily logged as well
+4. Provide an easy mechanism (like fmt.Println) to print info to the user
+ which can be easily logged as well
5. Due to 2 & 3 provide easy verbose mode for output and logs
6. Not have any unnecessary initialization cruft. Just use it.
-
diff -r 72745221b2fc -r 59b80206c852 devel/go-mapstructure/DESCR
--- a/devel/go-mapstructure/DESCR Fri Aug 25 16:06:44 2017 +0000
+++ b/devel/go-mapstructure/DESCR Fri Aug 25 16:30:23 2017 +0000
@@ -1,3 +1,8 @@
-mapstructure is a Go library for decoding generic map values to structures and vice versa, while providing helpful error handling.
+mapstructure is a Go library for decoding generic map values to structures and
+vice versa, while providing helpful error handling.
-This library is most useful when decoding values from some data stream (JSON, Gob, etc.) where you don't quite know the structure of the underlying data until you read a part of it. You can
therefore read a map[string]interface{} and use this library to decode it into the proper underlying native Go structure.
+This library is most useful when decoding values from some data stream (JSON,
+Gob, etc.) where you don't quite know the structure of the underlying data
+until you read a part of it. You can therefore read a map[string]interface{}
+and use this library to decode it into the proper underlying native Go
+structure.
diff -r 72745221b2fc -r 59b80206c852 devel/go-nitro/DESCR
--- a/devel/go-nitro/DESCR Fri Aug 25 16:06:44 2017 +0000
+++ b/devel/go-nitro/DESCR Fri Aug 25 16:30:23 2017 +0000
@@ -1,1 +1,3 @@
-Nitro is a quick and easy performance analyzer library for golang. It is useful for comparing A/B against different drafts of functions or different functions.
+Nitro is a quick and easy performance analyzer library for golang. It is
+useful for comparing A/B against different drafts of functions or different
+functions.
diff -r 72745221b2fc -r 59b80206c852 devel/go-osext/DESCR
--- a/devel/go-osext/DESCR Fri Aug 25 16:06:44 2017 +0000
+++ b/devel/go-osext/DESCR Fri Aug 25 16:30:23 2017 +0000
@@ -1,7 +1,11 @@
Extensions to the "os" package.
Find the current Executable and ExecutableFolder.
-There is sometimes utility in finding the current executable file that is running. This can be used for upgrading the current executable or finding resources located relative to the executable file.
Both working directory and the os.Args[0] value are arbitrary and cannot be relied on; os.Args[0] can be "faked".
+There is sometimes utility in finding the current executable file that is
+running. This can be used for upgrading the current executable or finding
+resources located relative to the executable file. Both working directory and
+the os.Args[0] value are arbitrary and cannot be relied on; os.Args[0] can be
+"faked".
Multi-platform and supports:
diff -r 72745221b2fc -r 59b80206c852 devel/go-pflag/DESCR
--- a/devel/go-pflag/DESCR Fri Aug 25 16:06:44 2017 +0000
+++ b/devel/go-pflag/DESCR Fri Aug 25 16:30:23 2017 +0000
@@ -1,5 +1,9 @@
-pflag is a drop-in replacement for Go's flag package, implementing POSIX/GNU-style --flags.
+pflag is a drop-in replacement for Go's flag package, implementing
+POSIX/GNU-style --flags.
-pflag is compatible with the GNU extensions to the POSIX recommendations for command-line options. For a more precise description, see the "Command-line flag syntax" section below.
+pflag is compatible with the GNU extensions to the POSIX recommendations for
+command-line options. For a more precise description, see the "Command-line
+flag syntax" section below.
-pflag is available under the same style of BSD license as the Go language, which can be found in the LICENSE file.
+pflag is available under the same style of BSD license as the Go language,
+which can be found in the LICENSE file.
diff -r 72745221b2fc -r 59b80206c852 devel/go-properties/DESCR
--- a/devel/go-properties/DESCR Fri Aug 25 16:06:44 2017 +0000
+++ b/devel/go-properties/DESCR Fri Aug 25 16:30:23 2017 +0000
@@ -1,11 +1,20 @@
properties is a Go library for reading and writing properties files.
-It supports reading from multiple files or URLs and Spring style recursive property expansion of expressions like ${key} to their corresponding value. Value expressions can refer to other keys like
in ${key} or to environment variables like in ${USER}. Filenames can also contain environment variables like in /home/${USER}/myapp.properties.
+It supports reading from multiple files or URLs and Spring style recursive
+property expansion of expressions like ${key} to their corresponding value.
+Value expressions can refer to other keys like in ${key} or to environment
+variables like in ${USER}. Filenames can also contain environment variables
+like in /home/${USER}/myapp.properties.
-Properties can be decoded into structs, maps, arrays and values through struct tags.
+Properties can be decoded into structs, maps, arrays and values through struct
Home |
Main Index |
Thread Index |
Old Index