Skip to content
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: note that fs.futimes only works on AIX >7.1 #13659

Closed
wants to merge 1 commit into from

Conversation

gibfahn
Copy link
Member

@gibfahn gibfahn commented Jun 13, 2017

Fixes: #12609

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • commit message follows commit guidelines
Affected core subsystem(s)

doc

cc/ @nodejs/platform-aix @gireeshpunathil

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. labels Jun 13, 2017
@gibfahn gibfahn added the aix Issues and PRs related to the AIX platform. label Jun 13, 2017
@gibfahn
Copy link
Member Author

gibfahn commented Jun 13, 2017

cc/ @aqrln @refack @jasnell @Trott re. #13133, what do you think of this for an AIX-specific note? I went with *Note (AIX):*

doc/api/fs.md Outdated
@@ -1225,6 +1225,9 @@ changes:
Change the file timestamps of a file referenced by the supplied file
descriptor.

*Note (AIX):* This function only works for AIX 7.1 and newer. It can still be
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe *Note*: AIX - ?
Re: #13133

doc/api/fs.md Outdated
@@ -1225,6 +1225,9 @@ changes:
Change the file timestamps of a file referenced by the supplied file
descriptor.

*Note (AIX):* This function only works for AIX 7.1 and newer. It can still be
called on older versions but will return `UV_ENOSYS`.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would just make it *Note*: given that the text clearly states AIX already.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or perhaps,

*Note*: For AIX systems, this function only works on 7.1 or newer. On older AIX versions, calling this function will always return `UV_ENOSYS`.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would keep 'AIX' in front of '7.1' to make it clear this refers to the OS version and not the Node.js version.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated, I think it should be unambiguous now.

doc/api/fs.md Outdated
@@ -1225,6 +1225,9 @@ changes:
Change the file timestamps of a file referenced by the supplied file
descriptor.

*Note:* This function only works for AIX 7.1 and newer. It can still be
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: *Note*:

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

doc/api/fs.md Outdated
@@ -1225,6 +1225,9 @@ changes:
Change the file timestamps of a file referenced by the supplied file
descriptor.

*Note*: This function only works for AIX 7.1 and newer. It can still be
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now it sounds like it doesn't work on non-AIX platforms.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestions welcome. I don't want it to get excessively long.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And I think the second sentence makes it pretty clear that this is an AIX specific issue.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*Note*: On AIX systems, this function only works for versions 7.1 and newer...

@gibfahn gibfahn force-pushed the futimes-aix branch 2 times, most recently from e7c2a0d to 9dae270 Compare June 14, 2017 20:08
@gibfahn
Copy link
Member Author

gibfahn commented Jun 14, 2017

@richardlau @jasnell reversed it to (hopefully) preserve clarity while maintaining brevity, PTAL.

doc/api/fs.md Outdated
@@ -1225,6 +1225,9 @@ changes:
Change the file timestamps of a file referenced by the supplied file
descriptor.

*Note*: This function does not work on AIX versions older than 7.1. It can still
be called but will return `UV_ENOSYS`.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This does not sound right. The earlier description said it only worked on version 7.1 and newer, now it says it no longer works after 7.1

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you saying that older for you means later?

it only worked on version 7.1 and newer

does not work on AIX versions older than 7.1

These two phrases seem identical to me.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bear with us @gibfahn, the bike shed is not quite yet the right shade ;-) ...

*Note*: This function does not work correctly on AIX versions older than 7.1 in that it will
always return the value `UV_ENOSYS`.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the idea of linking the two sentences, but that suggests that UV_ENOSYS is a reasonable thing for it to return. How about:

*Note*: This function does not work on AIX versions older than 7.1, 
it will return the error `UV_ENOSYS`.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about:

Note: This function does not work on AIX versions before 7.1,
it will return the error UV_ENOSYS.

While I agree older probably means the right thing the numbering is opposite to what usually comes to mind with older (ie 72 is older than 71 in years)

Copy link
Member Author

@gibfahn gibfahn Jun 16, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, let's see how it looks with js formatting:

*Note*: This function does not work on AIX versions before 7.1,
it will return the error UV_ENOSYS.

Yep, looks good to me.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this shade for the shed...

and it will return with error code UV_ENOSYS.

(with go coloring)

@richardlau
Copy link
Member

Given that since Node.js 8 we don't support AIX versions earlier than 7.1 TL04 (https://github.com/nodejs/node/blob/v8.0.0/BUILDING.md), do we need to document this limitation on 8 and master?

Definitely needs to be documented on the earlier Node.js release lines.

@gibfahn
Copy link
Member Author

gibfahn commented Jun 16, 2017

@richardlau @mhdawson LGTY?

@refack
Copy link
Contributor

refack commented Jun 28, 2017

@gibfahn land before the lighting changes and everyone wants a new color again.

jasnell pushed a commit that referenced this pull request Jun 29, 2017
PR-URL: #13659
Fixes: #12609
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> i
@jasnell
Copy link
Member

jasnell commented Jun 29, 2017

Landed in 4eeb4a4

@jasnell jasnell closed this Jun 29, 2017
@gibfahn gibfahn deleted the futimes-aix branch June 29, 2017 07:42
addaleax pushed a commit that referenced this pull request Jun 29, 2017
PR-URL: #13659
Fixes: #12609
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> i
@addaleax addaleax mentioned this pull request Jun 29, 2017
addaleax pushed a commit that referenced this pull request Jul 11, 2017
PR-URL: #13659
Fixes: #12609
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> i
addaleax pushed a commit that referenced this pull request Jul 18, 2017
PR-URL: #13659
Fixes: #12609
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> i
MylesBorins pushed a commit that referenced this pull request Aug 14, 2017
PR-URL: #13659
Fixes: #12609
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> i
MylesBorins pushed a commit that referenced this pull request Aug 15, 2017
PR-URL: #13659
Fixes: #12609
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> i
MylesBorins pushed a commit that referenced this pull request Aug 16, 2017
PR-URL: #13659
Fixes: #12609
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> i
@MylesBorins MylesBorins mentioned this pull request Aug 16, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
aix Issues and PRs related to the AIX platform. doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants