Skip to content

docs: add XML file usage examples to usage, man page, and README#152

Merged
vmvarela merged 1 commit into
masterfrom
issue-144/xml-usage-examples
May 10, 2026
Merged

docs: add XML file usage examples to usage, man page, and README#152
vmvarela merged 1 commit into
masterfrom
issue-144/xml-usage-examples

Conversation

@vmvarela
Copy link
Copy Markdown
Owner

Summary

  • Adds --xml-root / --xml-row XML input examples to all three documentation locations so users can discover the feature for nested documents like RSS feeds

Changes

  • src/args.zig (--help text): adds cat data.xml | sql-pipe -I xml --xml-root channel --xml-row item "SELECT title FROM t" to the Examples section
  • docs/sql-pipe.1.scd (man page): two new EXAMPLES entries — nested XML input with --xml-root/--xml-row (RSS-style), and CSV-to-XML output with custom element names
  • README.md: expands the XML section with a practical RSS-feed example showing when and how to use --xml-root and --xml-row

Closes #144

Add --xml-root / --xml-row flag examples in all three documentation
locations so users can discover XML input support for nested documents
like RSS feeds:

- src/args.zig (--help): add XML example with --xml-root / --xml-row
- docs/sql-pipe.1.scd: add two XML EXAMPLES entries (nested input with
  --xml-root/--xml-row, custom output element names)
- README.md: expand XML section with RSS-style nested-input example

Closes #144
@vmvarela vmvarela added type:docs Documentation only priority:medium Should be done soon size:s Small — 1 to 4 hours labels May 10, 2026
@vmvarela vmvarela merged commit ede09fe into master May 10, 2026
5 checks passed
@vmvarela vmvarela deleted the issue-144/xml-usage-examples branch May 10, 2026 11:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

priority:medium Should be done soon size:s Small — 1 to 4 hours type:docs Documentation only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: add XML file usage examples to usage, man page, and README

1 participant