Commit d8264de8 authored by Dmitri Shuralyov's avatar Dmitri Shuralyov Committed by Brad Fitzpatrick

all: spell "marshal" and "unmarshal" consistently

The tree is inconsistent about single l vs double l in those
words in documentation, test messages, and one error value text.

	$ git grep -E '[Mm]arshall(|s|er|ers|ed|ing)' | wc -l
	      42
	$ git grep -E '[Mm]arshal(|s|er|ers|ed|ing)' | wc -l
	    1694

Make it consistently a single l, per earlier decisions. This means
contributors won't be confused by misleading precedence, and it helps
consistency.

Change the spelling in one error value text in newRawAttributes of
crypto/x509 package to be consistent.

This change was generated with:

	perl -i -npe 's,([Mm]arshal)l(|s|er|ers|ed|ing),$1$2,' $(git grep -l -E '[Mm]arshall' | grep -v AUTHORS | grep -v CONTRIBUTORS)

Updates #12431.
Follows https://golang.org/cl/14150.

Change-Id: I85d28a2d7692862ccb02d6a09f5d18538b6049a2
Reviewed-on: https://go-review.googlesource.com/33017
Run-TryBot: Minux Ma <minux@golang.org>
TryBot-Result: Gobot Gobot <gobot@golang.org>
Reviewed-by: 's avatarBrad Fitzpatrick <bradfitz@golang.org>
parent 9a78eade
...@@ -2450,7 +2450,7 @@ The http package's URL parsing and query escaping code (such as ParseURL and ...@@ -2450,7 +2450,7 @@ The http package's URL parsing and query escaping code (such as ParseURL and
URLEscape) has been moved to the new url package, with several simplifications URLEscape) has been moved to the new url package, with several simplifications
to the names. Client code can be updated automatically with gofix. to the names. Client code can be updated automatically with gofix.
* asn1: support unmarshalling structs with int32 members (thanks Dave Cheney). * asn1: support unmarshaling structs with int32 members (thanks Dave Cheney).
* build: allow builds without cgo or hg, * build: allow builds without cgo or hg,
support versioning without hg (thanks Gustavo Niemeyer). support versioning without hg (thanks Gustavo Niemeyer).
* builtin: add documentation for builtins. * builtin: add documentation for builtins.
...@@ -3030,7 +3030,7 @@ Other changes: ...@@ -3030,7 +3030,7 @@ Other changes:
* 5g: alignment fixes. * 5g: alignment fixes.
* 6l, 8l: fix Mach-O binaries with many dynamic libraries. * 6l, 8l: fix Mach-O binaries with many dynamic libraries.
* 8l: emit resources (.rsrc) in Windows PE. (thanks Wei Guangjing). * 8l: emit resources (.rsrc) in Windows PE. (thanks Wei Guangjing).
* asn1: fix marshalling of empty optional RawValues (thanks Mikkel Krautz). * asn1: fix marshaling of empty optional RawValues (thanks Mikkel Krautz).
* big: make Int and Rat implement fmt.Scanner (thanks Evan Shaw), * big: make Int and Rat implement fmt.Scanner (thanks Evan Shaw),
~8x faster number scanning, ~8x faster number scanning,
remove some unnecessary conversions. remove some unnecessary conversions.
...@@ -4238,7 +4238,7 @@ example: http://golang.org/pkg/xml/ ...@@ -4238,7 +4238,7 @@ example: http://golang.org/pkg/xml/
<pre> <pre>
The json, gob, and template packages have changed, and code that uses them The json, gob, and template packages have changed, and code that uses them
may need to be updated after this release. They will no longer read or write may need to be updated after this release. They will no longer read or write
unexported struct fields. When marshalling a struct with json or gob the unexported struct fields. When marshaling a struct with json or gob the
unexported fields will be silently ignored. Attempting to unmarshal json or unexported fields will be silently ignored. Attempting to unmarshal json or
gob data into an unexported field will generate an error. Accessing an gob data into an unexported field will generate an error. Accessing an
unexported field from a template will cause the Execute function to return unexported field from a template will cause the Execute function to return
...@@ -5682,7 +5682,7 @@ Other changes: ...@@ -5682,7 +5682,7 @@ Other changes:
pidigits ~10% performance win by using adds instead of shifts. pidigits ~10% performance win by using adds instead of shifts.
* time: remove incorrect time.ISO8601 and add time.RFC3339 (thanks Micah Stetson). * time: remove incorrect time.ISO8601 and add time.RFC3339 (thanks Micah Stetson).
* utf16: add DecodeRune, EncodeRune. * utf16: add DecodeRune, EncodeRune.
* xml: add support for XML marshalling embedded structs (thanks Raif S. Naffah), * xml: add support for XML marshaling embedded structs (thanks Raif S. Naffah),
new "innerxml" tag to collect inner XML. new "innerxml" tag to collect inner XML.
</pre> </pre>
...@@ -5925,10 +5925,10 @@ Other changes and fixes: ...@@ -5925,10 +5925,10 @@ Other changes and fixes:
* 8a/8l: Added CMOVcc instructions (thanks Evan Shaw) * 8a/8l: Added CMOVcc instructions (thanks Evan Shaw)
* 8l: pe executable building code changed to include import table for kernel32.dll functions (thanks Alex Brainman) * 8l: pe executable building code changed to include import table for kernel32.dll functions (thanks Alex Brainman)
* 5g/6g/8g: bug fixes * 5g/6g/8g: bug fixes
* asn1: bug fixes and additions (incl marshalling) * asn1: bug fixes and additions (incl marshaling)
* build: fix build for Native Client, Linux/ARM * build: fix build for Native Client, Linux/ARM
* dashboard: show benchmarks, add garbage collector benchmarks * dashboard: show benchmarks, add garbage collector benchmarks
* encoding/pem: add marshalling support * encoding/pem: add marshaling support
* exp/draw: fast paths for a nil mask * exp/draw: fast paths for a nil mask
* godoc: support for directories outside $GOROOT * godoc: support for directories outside $GOROOT
* http: sort header keys when writing Response or Request to wire (thanks Petar Maymounkov) * http: sort header keys when writing Response or Request to wire (thanks Petar Maymounkov)
......
...@@ -28,7 +28,7 @@ func Encode() { ...@@ -28,7 +28,7 @@ func Encode() {
expected := []byte(`{"Name":"Alice","Body":"Hello","Time":1294706395881547000}`) expected := []byte(`{"Name":"Alice","Body":"Hello","Time":1294706395881547000}`)
if !reflect.DeepEqual(b, expected) { if !reflect.DeepEqual(b, expected) {
log.Panicf("Error marshalling %q, expected %q, got %q.", m, expected, b) log.Panicf("Error marshaling %q, expected %q, got %q.", m, expected, b)
} }
} }
...@@ -49,7 +49,7 @@ func Decode() { ...@@ -49,7 +49,7 @@ func Decode() {
} }
if !reflect.DeepEqual(m, expected) { if !reflect.DeepEqual(m, expected) {
log.Panicf("Error unmarshalling %q, expected %q, got %q.", b, expected, m) log.Panicf("Error unmarshaling %q, expected %q, got %q.", b, expected, m)
} }
m = Message{ m = Message{
...@@ -77,7 +77,7 @@ func PartialDecode() { ...@@ -77,7 +77,7 @@ func PartialDecode() {
} }
if !reflect.DeepEqual(expected, m) { if !reflect.DeepEqual(expected, m) {
log.Panicf("Error unmarshalling %q, expected %q, got %q.", b, expected, m) log.Panicf("Error unmarshaling %q, expected %q, got %q.", b, expected, m)
} }
} }
......
...@@ -33,7 +33,7 @@ func Decode() { ...@@ -33,7 +33,7 @@ func Decode() {
} }
if !reflect.DeepEqual(f, expected) { if !reflect.DeepEqual(f, expected) {
log.Panicf("Error unmarshalling %q, expected %q, got %q", b, expected, f) log.Panicf("Error unmarshaling %q, expected %q, got %q", b, expected, f)
} }
f = map[string]interface{}{ f = map[string]interface{}{
......
...@@ -36,7 +36,7 @@ func Decode() { ...@@ -36,7 +36,7 @@ func Decode() {
} }
if !reflect.DeepEqual(expected, m) { if !reflect.DeepEqual(expected, m) {
log.Panicf("Error unmarshalling %q, expected %q, got %q", b, expected, m) log.Panicf("Error unmarshaling %q, expected %q, got %q", b, expected, m)
} }
} }
......
...@@ -28,7 +28,7 @@ func TestOffCurve(t *testing.T) { ...@@ -28,7 +28,7 @@ func TestOffCurve(t *testing.T) {
b := Marshal(p224, x, y) b := Marshal(p224, x, y)
x1, y1 := Unmarshal(p224, b) x1, y1 := Unmarshal(p224, b)
if x1 != nil || y1 != nil { if x1 != nil || y1 != nil {
t.Errorf("FAIL: unmarshalling a point not on the curve succeeded") t.Errorf("FAIL: unmarshaling a point not on the curve succeeded")
} }
} }
......
...@@ -996,7 +996,7 @@ func (c *Conn) readHandshake() (interface{}, error) { ...@@ -996,7 +996,7 @@ func (c *Conn) readHandshake() (interface{}, error) {
return nil, c.in.setErrorLocked(c.sendAlert(alertUnexpectedMessage)) return nil, c.in.setErrorLocked(c.sendAlert(alertUnexpectedMessage))
} }
// The handshake message unmarshallers // The handshake message unmarshalers
// expect to be able to keep references to data, // expect to be able to keep references to data,
// so pass in a fresh copy that won't be overwritten. // so pass in a fresh copy that won't be overwritten.
data = append([]byte(nil), data...) data = append([]byte(nil), data...)
......
...@@ -1966,7 +1966,7 @@ func newRawAttributes(attributes []pkix.AttributeTypeAndValueSET) ([]asn1.RawVal ...@@ -1966,7 +1966,7 @@ func newRawAttributes(attributes []pkix.AttributeTypeAndValueSET) ([]asn1.RawVal
return nil, err return nil, err
} }
if len(rest) != 0 { if len(rest) != 0 {
return nil, errors.New("x509: failed to unmarshall raw CSR Attributes") return nil, errors.New("x509: failed to unmarshal raw CSR Attributes")
} }
return rawAttributes, nil return rawAttributes, nil
} }
......
...@@ -1755,8 +1755,8 @@ func TestStringKind(t *testing.T) { ...@@ -1755,8 +1755,8 @@ func TestStringKind(t *testing.T) {
} }
} }
// Custom types with []byte as underlying type could not be marshalled // Custom types with []byte as underlying type could not be marshaled
// and then unmarshalled. // and then unmarshaled.
// Issue 8962. // Issue 8962.
func TestByteKind(t *testing.T) { func TestByteKind(t *testing.T) {
type byteKind []byte type byteKind []byte
......
...@@ -501,7 +501,7 @@ func TestEncodePointerString(t *testing.T) { ...@@ -501,7 +501,7 @@ func TestEncodePointerString(t *testing.T) {
t.Fatalf("Unmarshal: %v", err) t.Fatalf("Unmarshal: %v", err)
} }
if back.N == nil { if back.N == nil {
t.Fatalf("Unmarshalled nil N field") t.Fatalf("Unmarshaled nil N field")
} }
if *back.N != 42 { if *back.N != 42 {
t.Fatalf("*N = %d; want 42", *back.N) t.Fatalf("*N = %d; want 42", *back.N)
...@@ -632,7 +632,7 @@ func TestTextMarshalerMapKeysAreSorted(t *testing.T) { ...@@ -632,7 +632,7 @@ func TestTextMarshalerMapKeysAreSorted(t *testing.T) {
var re = regexp.MustCompile var re = regexp.MustCompile
// syntactic checks on form of marshalled floating point numbers. // syntactic checks on form of marshaled floating point numbers.
var badFloatREs = []*regexp.Regexp{ var badFloatREs = []*regexp.Regexp{
re(`p`), // no binary exponential notation re(`p`), // no binary exponential notation
re(`^\+`), // no leading + sign re(`^\+`), // no leading + sign
......
...@@ -24,10 +24,10 @@ const ( ...@@ -24,10 +24,10 @@ const (
// Marshal returns the XML encoding of v. // Marshal returns the XML encoding of v.
// //
// Marshal handles an array or slice by marshalling each of the elements. // Marshal handles an array or slice by marshaling each of the elements.
// Marshal handles a pointer by marshalling the value it points at or, if the // Marshal handles a pointer by marshaling the value it points at or, if the
// pointer is nil, by writing nothing. Marshal handles an interface value by // pointer is nil, by writing nothing. Marshal handles an interface value by
// marshalling the value it contains or, if the interface value is nil, by // marshaling the value it contains or, if the interface value is nil, by
// writing nothing. Marshal handles all other data by writing one or more XML // writing nothing. Marshal handles all other data by writing one or more XML
// elements containing the data. // elements containing the data.
// //
...@@ -36,9 +36,9 @@ const ( ...@@ -36,9 +36,9 @@ const (
// - the value of the XMLName field of type Name // - the value of the XMLName field of type Name
// - the tag of the struct field used to obtain the data // - the tag of the struct field used to obtain the data
// - the name of the struct field used to obtain the data // - the name of the struct field used to obtain the data
// - the name of the marshalled type // - the name of the marshaled type
// //
// The XML element for a struct contains marshalled elements for each of the // The XML element for a struct contains marshaled elements for each of the
// exported fields of the struct, with these exceptions: // exported fields of the struct, with these exceptions:
// - the XMLName field, described above, is omitted. // - the XMLName field, described above, is omitted.
// - a field with tag "-" is omitted. // - a field with tag "-" is omitted.
...@@ -51,9 +51,9 @@ const ( ...@@ -51,9 +51,9 @@ const (
// - a field with tag ",cdata" is written as character data // - a field with tag ",cdata" is written as character data
// wrapped in one or more <![CDATA[ ... ]]> tags, not as an XML element. // wrapped in one or more <![CDATA[ ... ]]> tags, not as an XML element.
// - a field with tag ",innerxml" is written verbatim, not subject // - a field with tag ",innerxml" is written verbatim, not subject
// to the usual marshalling procedure. // to the usual marshaling procedure.
// - a field with tag ",comment" is written as an XML comment, not // - a field with tag ",comment" is written as an XML comment, not
// subject to the usual marshalling procedure. It must not contain // subject to the usual marshaling procedure. It must not contain
// the "--" string within it. // the "--" string within it.
// - a field with a tag including the "omitempty" option is omitted // - a field with a tag including the "omitempty" option is omitted
// if the field value is empty. The empty values are false, 0, any // if the field value is empty. The empty values are false, 0, any
......
...@@ -396,7 +396,7 @@ var ( ...@@ -396,7 +396,7 @@ var (
// Unless explicitly stated as such (or *Plain), all of the // Unless explicitly stated as such (or *Plain), all of the
// tests below are two-way tests. When introducing new tests, // tests below are two-way tests. When introducing new tests,
// please try to make them two-way as well to ensure that // please try to make them two-way as well to ensure that
// marshalling and unmarshalling are as symmetrical as feasible. // marshaling and unmarshaling are as symmetrical as feasible.
var marshalTests = []struct { var marshalTests = []struct {
Value interface{} Value interface{}
ExpectXML string ExpectXML string
......
...@@ -90,7 +90,7 @@ import ( ...@@ -90,7 +90,7 @@ import (
// * An anonymous struct field is handled as if the fields of its // * An anonymous struct field is handled as if the fields of its
// value were part of the outer struct. // value were part of the outer struct.
// //
// * A struct field with tag "-" is never unmarshalled into. // * A struct field with tag "-" is never unmarshaled into.
// //
// Unmarshal maps an XML element to a string or []byte by saving the // Unmarshal maps an XML element to a string or []byte by saving the
// concatenation of that element's character data in the string or // concatenation of that element's character data in the string or
...@@ -142,7 +142,7 @@ func (d *Decoder) DecodeElement(v interface{}, start *StartElement) error { ...@@ -142,7 +142,7 @@ func (d *Decoder) DecodeElement(v interface{}, start *StartElement) error {
return d.unmarshal(val.Elem(), start) return d.unmarshal(val.Elem(), start)
} }
// An UnmarshalError represents an error in the unmarshalling process. // An UnmarshalError represents an error in the unmarshaling process.
type UnmarshalError string type UnmarshalError string
func (e UnmarshalError) Error() string { return string(e) } func (e UnmarshalError) Error() string { return string(e) }
......
...@@ -705,7 +705,7 @@ func TestUnmarshalIntoInterface(t *testing.T) { ...@@ -705,7 +705,7 @@ func TestUnmarshalIntoInterface(t *testing.T) {
} }
pea, ok := pod.Pea.(*Pea) pea, ok := pod.Pea.(*Pea)
if !ok { if !ok {
t.Fatalf("unmarshalled into wrong type: have %T want *Pea", pod.Pea) t.Fatalf("unmarshaled into wrong type: have %T want *Pea", pod.Pea)
} }
have, want := pea.Cotelydon, "Green stuff" have, want := pea.Cotelydon, "Green stuff"
if have != want { if have != want {
......
...@@ -48,7 +48,7 @@ var tinfoLock sync.RWMutex ...@@ -48,7 +48,7 @@ var tinfoLock sync.RWMutex
var nameType = reflect.TypeOf(Name{}) var nameType = reflect.TypeOf(Name{})
// getTypeInfo returns the typeInfo structure with details necessary // getTypeInfo returns the typeInfo structure with details necessary
// for marshalling and unmarshalling typ. // for marshaling and unmarshaling typ.
func getTypeInfo(typ reflect.Type) (*typeInfo, error) { func getTypeInfo(typ reflect.Type) (*typeInfo, error) {
tinfoLock.RLock() tinfoLock.RLock()
tinfo, ok := tinfoMap[typ] tinfo, ok := tinfoMap[typ]
...@@ -214,7 +214,7 @@ func structFieldInfo(typ reflect.Type, f *reflect.StructField) (*fieldInfo, erro ...@@ -214,7 +214,7 @@ func structFieldInfo(typ reflect.Type, f *reflect.StructField) (*fieldInfo, erro
} }
// If the field type has an XMLName field, the names must match // If the field type has an XMLName field, the names must match
// so that the behavior of both marshalling and unmarshalling // so that the behavior of both marshaling and unmarshaling
// is straightforward and unambiguous. // is straightforward and unambiguous.
if finfo.flags&fElement != 0 { if finfo.flags&fElement != 0 {
ftyp := f.Type ftyp := f.Type
...@@ -334,7 +334,7 @@ Loop: ...@@ -334,7 +334,7 @@ Loop:
return nil return nil
} }
// A TagPathError represents an error in the unmarshalling process // A TagPathError represents an error in the unmarshaling process
// caused by the use of field tags with conflicting paths. // caused by the use of field tags with conflicting paths.
type TagPathError struct { type TagPathError struct {
Struct reflect.Type Struct reflect.Type
......
...@@ -129,7 +129,7 @@ then the template output is ...@@ -129,7 +129,7 @@ then the template output is
<script>var pair = {"A": "foo", "B": "bar"};</script> <script>var pair = {"A": "foo", "B": "bar"};</script>
See package json to understand how non-string content is marshalled for See package json to understand how non-string content is marshaled for
embedding in JavaScript contexts. embedding in JavaScript contexts.
......
...@@ -162,14 +162,14 @@ func jsValEscaper(args ...interface{}) string { ...@@ -162,14 +162,14 @@ func jsValEscaper(args ...interface{}) string {
// a division operator it is not turned into a line comment: // a division operator it is not turned into a line comment:
// x/{{y}} // x/{{y}}
// turning into // turning into
// x//* error marshalling y: // x//* error marshaling y:
// second line of error message */null // second line of error message */null
return fmt.Sprintf(" /* %s */null ", strings.Replace(err.Error(), "*/", "* /", -1)) return fmt.Sprintf(" /* %s */null ", strings.Replace(err.Error(), "*/", "* /", -1))
} }
// TODO: maybe post-process output to prevent it from containing // TODO: maybe post-process output to prevent it from containing
// "<!--", "-->", "<![CDATA[", "]]>", or "</script" // "<!--", "-->", "<![CDATA[", "]]>", or "</script"
// in case custom marshallers produce output containing those. // in case custom marshalers produce output containing those.
// TODO: Maybe abbreviate \u00ab to \xab to produce more compact output. // TODO: Maybe abbreviate \u00ab to \xab to produce more compact output.
if len(b) == 0 { if len(b) == 0 {
......
...@@ -16,7 +16,7 @@ const floatGobVersion byte = 1 ...@@ -16,7 +16,7 @@ const floatGobVersion byte = 1
// GobEncode implements the gob.GobEncoder interface. // GobEncode implements the gob.GobEncoder interface.
// The Float value and all its attributes (precision, // The Float value and all its attributes (precision,
// rounding mode, accuracy) are marshalled. // rounding mode, accuracy) are marshaled.
func (x *Float) GobEncode() ([]byte, error) { func (x *Float) GobEncode() ([]byte, error) {
if x == nil { if x == nil {
return nil, nil return nil, nil
......
...@@ -59,7 +59,7 @@ func (z *Int) UnmarshalText(text []byte) error { ...@@ -59,7 +59,7 @@ func (z *Int) UnmarshalText(text []byte) error {
return nil return nil
} }
// The JSON marshallers are only here for API backward compatibility // The JSON marshalers are only here for API backward compatibility
// (programs that explicitly look for these two methods). JSON works // (programs that explicitly look for these two methods). JSON works
// fine with the TextMarshaler only. // fine with the TextMarshaler only.
......
...@@ -69,7 +69,7 @@ const ( ...@@ -69,7 +69,7 @@ const (
) )
// A dnsStruct describes how to iterate over its fields to emulate // A dnsStruct describes how to iterate over its fields to emulate
// reflective marshalling. // reflective marshaling.
type dnsStruct interface { type dnsStruct interface {
// Walk iterates over fields of a structure and calls f // Walk iterates over fields of a structure and calls f
// with a reference to that field, the name of the field // with a reference to that field, the name of the field
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
// Use of this source code is governed by a BSD-style // Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file. // license that can be found in the LICENSE file.
// Plan 9 directory marshalling. See intro(5). // Plan 9 directory marshaling. See intro(5).
package syscall package syscall
......
...@@ -14,7 +14,7 @@ import "fmt" ...@@ -14,7 +14,7 @@ import "fmt"
func f(x float64) float64 { func f(x float64) float64 {
// y is allocated to X0 // y is allocated to X0
y := x + 5 y := x + 5
// marshals z before y. Marshalling z // marshals z before y. Marshaling z
// calls DUFFCOPY. // calls DUFFCOPY.
return g(z, y) return g(z, y)
} }
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment