]> git.ipfire.org Git - thirdparty/util-linux.git/commit
docs: replace howto-*.txt with HOWTO-*.md and add AGENTS.md
authorKarel Zak <kzak@redhat.com>
Mon, 29 Jun 2026 11:54:10 +0000 (13:54 +0200)
committerKarel Zak <kzak@redhat.com>
Mon, 29 Jun 2026 11:54:10 +0000 (13:54 +0200)
commit4d18877a660517e047348fcfdf6964440673a3e7
treeaf95aaffdd5393c7b7204269eeb46fd7cf64522a
parentb15742bf5aff23f4d21565fbb6ce31b13c54263d
docs: replace howto-*.txt with HOWTO-*.md and add AGENTS.md

Replace the eight Documentation/howto-*.txt files with four consolidated
markdown documents:

  HOWTO-BUILDING.md     - compilation and build system internals
  HOWTO-CONTRIBUTING.md - contribution guidelines and PR workflow
  HOWTO-HACKING.md      - usage functions, man pages, debugging
  HOWTO-TESTING.md      - test framework, env variables, fuzz targets

Add AGENTS.md to the project root with AI-specific coding guidance
(code style pitfalls, return conventions, memory management, commit
message format) and links to the new documentation files.

Rename 00-about-docs.txt to 00-about-docs.md with updated references.

Signed-off-by: Karel Zak <kzak@redhat.com>
15 files changed:
AGENTS.md [new file with mode: 0644]
Documentation/00-about-docs.md [new file with mode: 0644]
Documentation/00-about-docs.txt [deleted file]
Documentation/HOWTO-BUILDING.md [new file with mode: 0644]
Documentation/HOWTO-CONTRIBUTING.md [new file with mode: 0644]
Documentation/HOWTO-HACKING.md [new file with mode: 0644]
Documentation/HOWTO-TESTING.md [new file with mode: 0644]
Documentation/howto-build-sys.txt [deleted file]
Documentation/howto-compilation.txt [deleted file]
Documentation/howto-contribute.txt [deleted file]
Documentation/howto-debug.txt [deleted file]
Documentation/howto-man-page.txt [deleted file]
Documentation/howto-pull-request.txt [deleted file]
Documentation/howto-tests.txt [deleted file]
Documentation/howto-usage-function.txt [deleted file]