Skip to content

Commit 779b263

Browse files
committed
Updating references to yq being a YAML processor
1 parent 638deed commit 779b263

File tree

7 files changed

+14
-12
lines changed

7 files changed

+14
-12
lines changed

.github/workflows/docker-release.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ jobs:
4545
docker buildx build \
4646
--label "org.opencontainers.image.authors=https://github.com/mikefarah/yq/graphs/contributors" \
4747
--label "org.opencontainers.image.created=$(date --rfc-3339=seconds)" \
48-
--label "org.opencontainers.image.description=yq is a portable command-line YAML processor" \
48+
--label "org.opencontainers.image.description=yq is a portable command-line data file processor" \
4949
--label "org.opencontainers.image.documentation=https://mikefarah.gitbook.io/yq/" \
5050
--label "org.opencontainers.image.licenses=MIT" \
5151
--label "org.opencontainers.image.revision=$(git rev-parse HEAD)" \
@@ -65,7 +65,7 @@ jobs:
6565
docker buildx build \
6666
--label "org.opencontainers.image.authors=https://github.com/mikefarah/yq/graphs/contributors" \
6767
--label "org.opencontainers.image.created=$(date --rfc-3339=seconds)" \
68-
--label "org.opencontainers.image.description=yq is a portable command-line YAML processor" \
68+
--label "org.opencontainers.image.description=yq is a portable command-line data file processor" \
6969
--label "org.opencontainers.image.documentation=https://mikefarah.gitbook.io/yq/" \
7070
--label "org.opencontainers.image.licenses=MIT" \
7171
--label "org.opencontainers.image.revision=$(git rev-parse HEAD)" \

cmd/evaluate_all_command.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ yq ea '. as $item ireduce ({}; . * $item )' file1.yml file2.yml ...
2626
## use '-' as a filename to pipe from STDIN
2727
cat file2.yml | yq ea '.a.b' file1.yml - file3.yml
2828
`,
29-
Long: `yq is a portable command-line YAML processor (https://github.com/mikefarah/yq/)
29+
Long: `yq is a portable command-line data file processor (https://github.com/mikefarah/yq/)
3030
See https://mikefarah.gitbook.io/yq/ for detailed documentation and examples.
3131
3232
## Evaluate All ##

cmd/evaluate_sequence_command.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ yq e -n '.a.b.c = "cat"'
3131
# Update a file in place
3232
yq e '.a.b = "cool"' -i file.yaml
3333
`,
34-
Long: `yq is a portable command-line YAML processor (https://github.com/mikefarah/yq/)
34+
Long: `yq is a portable command-line data file processor (https://github.com/mikefarah/yq/)
3535
See https://mikefarah.gitbook.io/yq/ for detailed documentation and examples.
3636
3737
## Evaluate Sequence ##

cmd/root.go

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,13 @@ import (
1111
func New() *cobra.Command {
1212
var rootCmd = &cobra.Command{
1313
Use: "yq",
14-
Short: "yq is a lightweight and portable command-line YAML processor.",
15-
Long: `yq is a portable command-line YAML processor (https://github.com/mikefarah/yq/)
14+
Short: "yq is a lightweight and portable command-line data file processor.",
15+
Long: `yq is a portable command-line data file processor (https://github.com/mikefarah/yq/)
1616
See https://mikefarah.gitbook.io/yq/ for detailed documentation and examples.`,
1717
Example: `
18-
# yq defaults to 'eval' command if no command is specified. See "yq eval --help" for more examples.
18+
# yq tries to auto-detect the file format based off the extension, and defaults to YAML if it's unknown (or piping through STDIN)
19+
# Use the '-p/--input-format' flag to specify a format type.
20+
cat file.xml | yq -p xml
1921
2022
# read the "stuff" node from "myfile.yml"
2123
yq '.stuff' < myfile.yml

debian/control

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ XSBC-Original-Maintainer: Roberto Mier Escandón <[email protected]>
1616
Package: yq
1717
Architecture: any
1818
Depends: ${shlibs:Depends}, ${misc:Depends}
19-
Description: lightweight and portable command-line YAML processor
19+
Description: lightweight and portable command-line data file processor
2020
.
2121
The aim of the project is to be the
2222
[jq](https://github.com/stedolan/jq) or sed of yaml files.

pkg/yqlib/doc/operators/headers/Main.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# NAME
2-
*yq* is a portable command-line YAML processor
2+
*yq* is a portable command-line data file processor
33

44
# SYNOPSIS
55

@@ -11,7 +11,7 @@ eval-all/ea - Loads all yaml documents of all yaml files and runs expression onc
1111

1212
# DESCRIPTION
1313

14-
a lightweight and portable command-line YAML processor. `yq` uses [jq](https://github.com/stedolan/jq) like syntax but works with yaml files as well as json. It doesn't yet support everything `jq` does - but it does support the most common operations and functions, and more is being added continuously.
14+
a lightweight and portable command-line data file processor. `yq` uses [jq](https://github.com/stedolan/jq) like syntax but works with yaml, json, xml, csv, properties and TOML files. It doesn't yet support everything `jq` does - but it does support the most common operations and functions, and more is being added continuously.
1515

1616
This documentation is also available at https://mikefarah.gitbook.io/yq/
1717
# QUICK GUIDE

snap/snapcraft.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
name: yq
22
version: 'v4.40.3'
3-
summary: A lightweight and portable command-line YAML processor
3+
summary: A lightweight and portable command-line data file processor
44
description: |
5-
The aim of the project is to be the jq or sed of yaml files.
5+
`yq` uses [jq](https://github.com/stedolan/jq) like syntax but works with yaml, json, xml, csv, properties and TOML files.
66
base: core18
77
grade: stable # devel|stable. must be 'stable' to release into candidate/stable channels
88
confinement: strict

0 commit comments

Comments
 (0)