Skip to content

Commit 9386b67

Browse files
wkingMa Shimiao
authored andcommitted
config: Consistent Markdown/Go wording for 'hostname'
I've changed the old "as it is accessible to ..." to the more compact "as seen by ..." language from the old Markdown version, although I don't think it's strictly necessary. The original "accessbile to" language is from 77d44b1 (Update runtime.md, 2015-06-16), which actually looked fairly similar to the language I'm using here. That commit's "hostname for the container" lanuage went away in 7ac41c6 (config.md: reformat into a standard style, 2015-06-30), although that commit made too many changes to motivate them all at that level. I've left that language out of the Go comment, because truncating for compact Go comments is fine (the Markdown entry is canonical, and the Go comment is just to provide some minimal context). Signed-off-by: W. Trevor King <[email protected]>
1 parent 9da42af commit 9386b67

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ _Note: For Solaris, uid and gid specify the uid and gid of the process inside th
191191

192192
## Hostname
193193

194-
* **`hostname`** (string, optional) as it is accessible to processes running inside.
194+
* **`hostname`** (string, optional) configures the container's hostname as seen by processes running inside the container.
195195
On Linux, you can only set this if your bundle creates a new [UTS namespace][uts-namespace].
196196

197197
### Example

specs-go/config.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ type Spec struct {
1212
Process Process `json:"process"`
1313
// Root configures the container's root filesystem.
1414
Root Root `json:"root"`
15-
// Hostname is the container's host name.
15+
// Hostname configures the container's hostname.
1616
Hostname string `json:"hostname,omitempty"`
1717
// Mounts profile configuration for adding mounts to the container's filesystem.
1818
Mounts []Mount `json:"mounts,omitempty"`

0 commit comments

Comments
 (0)