Skip to content

config.md: fix ambiguous words - #879

Closed
Mashimiao wants to merge 1 commit into
opencontainers:masterfrom
Mashimiao:ambiguous-fix
Closed

config.md: fix ambiguous words#879
Mashimiao wants to merge 1 commit into
opencontainers:masterfrom
Mashimiao:ambiguous-fix

Conversation

@Mashimiao

Copy link
Copy Markdown

Signed-off-by: Ma Shimiao mashimiao.fnst@cn.fujitsu.com

@dqminh

dqminh commented Jul 5, 2017

Copy link
Copy Markdown
Contributor

path must be an absolute path sounds a bit strange for me. I would be curious on why do you think the original phrase was confusing.

@Mashimiao

Copy link
Copy Markdown
Author

First, I think absolute path is one kind one set phrase. Just say a path is absolute seems not suitable, because absolute has several meanings, we can't express ourself very clearly.
Second, we can see many other places in spec use absolute path.

@tianon tianon added this to the 1.1.0 milestone Jul 5, 2017
@wking

wking commented Jul 10, 2017 via email

Copy link
Copy Markdown
Contributor

Signed-off-by: Ma Shimiao <mashimiao.fnst@cn.fujitsu.com>
@Mashimiao

Copy link
Copy Markdown
Author

I don't think we need to add local definition. It almost a common view, we can assume readers know what absolute path or relative path is. Does POSIX add its own local definition?

@hqhq

hqhq commented Jul 11, 2017

Copy link
Copy Markdown
Contributor

The original phrase looks pretty clear to me.

@Mashimiao

Copy link
Copy Markdown
Author

That's not only problem about looks clear or not but also consistent in document

@wking

wking commented Jul 11, 2017 via email

Copy link
Copy Markdown
Contributor

@tianon

tianon commented Jul 13, 2017 via email

Copy link
Copy Markdown
Member

Comment thread config.md
* Solaris: corresponds to "dir" of the fs resource in [zonecfg(1M)][zonecfg.1m].
* **`source`** (string, OPTIONAL) A device name, but can also be a directory name or a dummy.
Path values are either absolute or relative to the bundle.
Path values are either absolute path or relative path to the bundle.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This seems redundant. In the current wording, "absolute" and "relative" are adjectives describing the "Path values", and usage like "X path is absolute" or "X path is relative" are pretty common.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

OK, closing it.

@wking

wking commented Jul 14, 2017 via email

Copy link
Copy Markdown
Contributor

@tianon

tianon commented Jul 14, 2017 via email

Copy link
Copy Markdown
Member

@epilatow

Copy link
Copy Markdown
Contributor

The solaris kernel path parser maps path components like '//' and '/./' to '/'. An absolute path on solaris is one that begins with '/'. Imo code that treats things like '//' and '/./' as invalid path components is being overly pedantic and user-unfriendly.

@wking

wking commented Jul 14, 2017 via email

Copy link
Copy Markdown
Contributor

@Mashimiao Mashimiao closed this Aug 3, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants