code review 5774043: io: more docs on WriterAt

io: more docs on WriterAt

Updates issue 1599

[bradfitz, 2012-03-07 17:45:46]

Hello golang-dev@googlegroups.com,

I'd like you to review this change to
https://go.googlecode.com/hg/

[gri, 2012-03-07 17:49:54]

LGTM

but rsc may have more to say
- gri

On Wed, Mar 7, 2012 at 9:45 AM,  <bradfitz@golang.org> wrote:
> Reviewers: golang-dev_googlegroups.com,
>
> Message:
> Hello golang-dev@googlegroups.com,
>
> I'd like you to review this change to
> https://go.googlecode.com/hg/
>
>
> Description:
> io: more docs on WriterAt
>
> Updates issue 1599
>
> Please review this at http://codereview.appspot.com/5774043/
>
> Affected files:
>  M src/pkg/io/io.go
>
>
> Index: src/pkg/io/io.go
> ===================================================================
> --- a/src/pkg/io/io.go
> +++ b/src/pkg/io/io.go
> @@ -173,6 +173,14 @@
>  // at offset off.  It returns the number of bytes written from p (0 <= n <=
> len(p))
>  // and any error encountered that caused the write to stop early.
>  // WriteAt must return a non-nil error if it returns n < len(p).
> +//
> +// If WriteAt is writing to a destination with a seek offset,
> +// WriteAt should not affect nor be affected by the underlying
> +// seek offset.
> +//
> +// Clients of WriteAt can execute parallel WriteAt calls on the same
> +// destination if the ranges are not overlapping, else the result
> +// is undefined.
>  type WriterAt interface {
>        WriteAt(p []byte, off int64) (n int, err error)
>  }
>
>

[bradfitz, 2012-03-07 18:32:45]

Thanks. Will wait on more feedback, then.

On Wed, Mar 7, 2012 at 9:49 AM, Robert Griesemer <gri@golang.org> wrote:

> LGTM
>
> but rsc may have more to say
> - gri
>
> On Wed, Mar 7, 2012 at 9:45 AM,  <bradfitz@golang.org> wrote:
> > Reviewers: golang-dev_googlegroups.com,
> >
> > Message:
> > Hello golang-dev@googlegroups.com,
> >
> > I'd like you to review this change to
> > https://go.googlecode.com/hg/
> >
> >
> > Description:
> > io: more docs on WriterAt
> >
> > Updates issue 1599
> >
> > Please review this at http://codereview.appspot.com/5774043/
> >
> > Affected files:
> >  M src/pkg/io/io.go
> >
> >
> > Index: src/pkg/io/io.go
> > ===================================================================
> > --- a/src/pkg/io/io.go
> > +++ b/src/pkg/io/io.go
> > @@ -173,6 +173,14 @@
> >  // at offset off.  It returns the number of bytes written from p (0 <=
> n <=
> > len(p))
> >  // and any error encountered that caused the write to stop early.
> >  // WriteAt must return a non-nil error if it returns n < len(p).
> > +//
> > +// If WriteAt is writing to a destination with a seek offset,
> > +// WriteAt should not affect nor be affected by the underlying
> > +// seek offset.
> > +//
> > +// Clients of WriteAt can execute parallel WriteAt calls on the same
> > +// destination if the ranges are not overlapping, else the result
> > +// is undefined.
> >  type WriterAt interface {
> >        WriteAt(p []byte, off int64) (n int, err error)
> >  }
> >
> >
>

[rsc, 2012-03-07 18:36:36]

LGTM

http://codereview.appspot.com/5774043/diff/4001/src/pkg/io/io.go
File src/pkg/io/io.go (right):

http://codereview.appspot.com/5774043/diff/4001/src/pkg/io/io.go#newcode182
src/pkg/io/io.go:182: // destination if the ranges are not overlapping, else the
result
Delete after ,

[bradfitz, 2012-03-07 18:54:08]

*** Submitted as http://code.google.com/p/go/source/detail?r=41543746506f ***

io: more docs on WriterAt

Updates issue 1599

R=golang-dev, gri, rsc
CC=golang-dev
http://codereview.appspot.com/5774043

[adg, 2012-03-08 00:56:08]

http://codereview.appspot.com/5774043/diff/8001/src/pkg/io/io.go
File src/pkg/io/io.go (right):

http://codereview.appspot.com/5774043/diff/8001/src/pkg/io/io.go#newcode182
src/pkg/io/io.go:182: // destination if the ranges are not overlapping.
s/are not overlapping/do not overlap/.

[adg, 2012-03-08 00:57:58]

On 8 March 2012 11:56,  <adg@golang.org> wrote:
>
> http://codereview.appspot.com/5774043/diff/8001/src/pkg/io/io.go
> File src/pkg/io/io.go (right):
>
> http://codereview.appspot.com/5774043/diff/8001/src/pkg/io/io.go#newcode182
> src/pkg/io/io.go:182: // destination if the ranges are not overlapping.
> s/are not overlapping/do not overlap/.
>
> http://codereview.appspot.com/5774043/

Uhh, somehow I didn't see this entire discussion thread until now.
Ignore if you like.

[bradfitz, 2012-03-08 00:58:48]

feel free to fix. :)

On Wed, Mar 7, 2012 at 4:56 PM, <adg@golang.org> wrote:

>
>
http://codereview.appspot.com/**5774043/diff/8001/src/pkg/io/**io.go<http://c...
> File src/pkg/io/io.go (right):
>
> http://codereview.appspot.com/**5774043/diff/8001/src/pkg/io/**
>
io.go#newcode182<http://codereview.appspot.com/5774043/diff/8001/src/pkg/io/io.go#newcode182>
> src/pkg/io/io.go:182: // destination if the ranges are not overlapping.
> s/are not overlapping/do not overlap/.
>
>
http://codereview.appspot.com/**5774043/<http://codereview.appspot.com/5774043/>
>