Skip to content

Commit d7fce83

Browse files
committed
Update comments
Co-authored-by: Ryan Bottriell <[email protected]> Signed-off-by: David Gilligan-Cook <[email protected]>
1 parent 20462e2 commit d7fce83

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

crates/spk-cli/group2/src/cmd_new.rs

+5-5
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,11 @@ fn get_stub(name: &PkgNameBuf) -> String {
4444
4545
build:
4646
47-
# Set what level of host os compatibility the built package should have:
48-
# - full: package can be used on any OS
49-
# - os: package can be used anywhere that has the same OS type
50-
# - arch: package can be used anywhere that has the same OS and CPU type
51-
# - distro: package can only be used on the same OS, CPU, and OS distribution version
47+
# Set what level of host compatibility the built package should have:
48+
# - full: package can be used on any OS and any architecture
49+
# - os: package can be used anywhere that has the same OS type (mac, linux, windows)
50+
# - arch: package can be used anywhere that has the same OS and CPU architecture (x86_64, i386)
51+
# - distro: package can only be used on the same OS, CPU, and OS distribution version (eg linux distro)
5252
host_compat: distro
5353
5454
# options are all the inputs to the package build process, including

crates/spk-schema/src/build_spec.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ const ARCH_ADDS: &[&OptName] = &[OptName::os(), OptName::arch()];
2828
const OS_ADDS: &[&OptName] = &[OptName::os()];
2929
const ANY_ADDS: &[&OptName] = &[];
3030

31-
/// Set what level of cross-platform compatibility the built package
31+
/// Describes what level of cross-platform compatibility the built package
3232
/// should have.
3333
#[derive(
3434
Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd, Deserialize, Serialize, Display, Default,

docs/ref/spec.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ The ValidationSpec modifies the default validation process for packages, primari
120120

121121
### HostCompat
122122

123-
The HostCompat value sets the host os related options that are
123+
The HostCompat value sets the host- and os-related options that are
124124
automatically added to each build. It also describes the package's
125125
compatibility with host OSes.
126126

0 commit comments

Comments
 (0)