New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: clarify fs.read() #14631

Closed
wants to merge 2 commits into
base: master
from

Conversation

Projects
None yet
7 participants
@Trott
Member

Trott commented Aug 4, 2017

First commit (originally from #14612, closed by OP, authorship of @dcharbonnier retained in the commit, hope this isn't rude of me, this PR is just me trying to get that across the finish line):

doc: clarify the position argument for fs.read

What happen to the file position after a read using a position null or
integer was not clear and you can assume that the cursor of the file
descriptor is updated even if position is an integer.

Fixes: https://github.com/nodejs/node/issues/8397

Second commit (implements a few of the comments from that PR):

doc: improve fs.read() doc text
Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc fs

dcharbonnier and others added some commits Aug 3, 2017

doc: clarify the position argument for fs.read
What happen to the file position after a read using a position null or
integer was not clear and you can assume that the cursor of the file
descriptor is updated even if position is an integer.

Fixes: #8397
@Trott

This comment has been minimized.

Show comment
Hide comment
@Trott

Trott Aug 4, 2017

Member

(If OP wants to re-open #14612, I'm totally happy to close this, or remove their commit so there's no conflict, or whatever.)

Member

Trott commented Aug 4, 2017

(If OP wants to re-open #14612, I'm totally happy to close this, or remove their commit so there's no conflict, or whatever.)

@jasnell

jasnell approved these changes Aug 4, 2017

@cjihrig

cjihrig approved these changes Aug 4, 2017

@Trott

This comment has been minimized.

Show comment
Hide comment
@Trott

Trott Aug 7, 2017

Member

Landed in 680285c and 0f325aa

Thanks, @dcharbonnier! 🎉

Member

Trott commented Aug 7, 2017

Landed in 680285c and 0f325aa

Thanks, @dcharbonnier! 🎉

@Trott Trott closed this Aug 7, 2017

Trott added a commit that referenced this pull request Aug 7, 2017

doc: clarify the position argument for fs.read
What happen to the file position after a read using a position null or
integer was not clear and you can assume that the cursor of the file
descriptor is updated even if position is an integer.

PR-URL: #14631
Fixes: #8397
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>

Trott added a commit that referenced this pull request Aug 7, 2017

doc: improve fs.read() doc text
PR-URL: #14631
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>

addaleax added a commit that referenced this pull request Aug 10, 2017

doc: clarify the position argument for fs.read
What happen to the file position after a read using a position null or
integer was not clear and you can assume that the cursor of the file
descriptor is updated even if position is an integer.

PR-URL: #14631
Fixes: #8397
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>

addaleax added a commit that referenced this pull request Aug 10, 2017

doc: improve fs.read() doc text
PR-URL: #14631
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>

icarter09 added a commit to icarter09/node that referenced this pull request Aug 12, 2017

doc: clarify the position argument for fs.read
What happen to the file position after a read using a position null or
integer was not clear and you can assume that the cursor of the file
descriptor is updated even if position is an integer.

PR-URL: nodejs#14631
Fixes: nodejs#8397
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>

icarter09 added a commit to icarter09/node that referenced this pull request Aug 12, 2017

doc: improve fs.read() doc text
PR-URL: nodejs#14631
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>

@addaleax addaleax referenced this pull request Aug 13, 2017

Merged

v8.4.0 proposal #14811

@MylesBorins

This comment has been minimized.

Show comment
Hide comment
@MylesBorins

MylesBorins Sep 19, 2017

Member

is this relevant to v6.x?

Member

MylesBorins commented Sep 19, 2017

is this relevant to v6.x?

@Trott

This comment has been minimized.

Show comment
Hide comment
@Trott

Trott Sep 19, 2017

Member

is this relevant to v6.x?

I believe so. I think it applies to 4.x as well. @nodejs/fs

Member

Trott commented Sep 19, 2017

is this relevant to v6.x?

I believe so. I think it applies to 4.x as well. @nodejs/fs

MylesBorins added a commit that referenced this pull request Sep 20, 2017

doc: clarify the position argument for fs.read
What happen to the file position after a read using a position null or
integer was not clear and you can assume that the cursor of the file
descriptor is updated even if position is an integer.

PR-URL: #14631
Fixes: #8397
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>

MylesBorins added a commit that referenced this pull request Sep 20, 2017

doc: improve fs.read() doc text
PR-URL: #14631
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>

@MylesBorins MylesBorins referenced this pull request Sep 20, 2017

Merged

v6.11.4 proposal #15506

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment