Skip to content

docs/cmdline: change to .md for cmdline docs#12751

Closed
bagder wants to merge 1 commit intomasterfrom
bagder/cmdline-md
Closed

docs/cmdline: change to .md for cmdline docs#12751
bagder wants to merge 1 commit intomasterfrom
bagder/cmdline-md

Conversation

@bagder
Copy link
Copy Markdown
Member

@bagder bagder commented Jan 21, 2024

  • switch all invidual files documenting command line options into .md, as the documentation is now markdown-looking.

  • made the parser treat 4-space indents as quotes

  • switch to building the curl.1 manpage using the "mainpage.idx" file, which lists the files to include to generate it, instead of using the previous page-footer/headers. Also, those files are now also .md ones, using the same format. I gave them underscore prefixes to make them sort separately: _NAME.md, _SYNOPSIS.md, _DESCRIPTION.md, _URL.md, _GLOBBING.md,
    _VARIABLES.md, _OUTPUT.md, _PROTOCOLS.md, _PROGRESS.md, _VERSION.md,
    _OPTIONS.md, _FILES.md, _ENVIRONMENT.md, _PROXYPREFIX.md,
    _EXITCODES.md, _BUGS.md, _AUTHORS.md, _WWW.md, _SEEALSO.md

@github-actions github-actions bot added tests CI Continuous Integration labels Jan 22, 2024
@bagder bagder force-pushed the bagder/cmdline-md branch from 022e126 to 9183e1f Compare January 22, 2024 10:12
@bagder bagder marked this pull request as ready for review January 22, 2024 10:16
 - switch all invidual files documenting command line options into .md,
   as the documentation is now markdown-looking.

 - made the parser treat 4-space indents as quotes

 - switch to building the curl.1 manpage using the "mainpage.idx" file,
   which lists the files to include to generate it, instead of using the
   previous page-footer/headers. Also, those files are now also .md
   ones, using the same format. I gave them underscore prefixes to make
   them sort separately:
   _NAME.md, _SYNOPSIS.md, _DESCRIPTION.md, _URL.md, _GLOBBING.md,
   _VARIABLES.md, _OUTPUT.md, _PROTOCOLS.md, _PROGRESS.md, _VERSION.md,
   _OPTIONS.md, _FILES.md, _ENVIRONMENT.md, _PROXYPREFIX.md,
   _EXITCODES.md, _BUGS.md, _AUTHORS.md, _WWW.md, _SEEALSO.md

 - updated test cases accordingly

Closes #12751
@bagder bagder force-pushed the bagder/cmdline-md branch from 29900e6 to feba857 Compare January 23, 2024 07:47
@bagder bagder closed this in 2494b8d Jan 23, 2024
@bagder bagder deleted the bagder/cmdline-md branch January 23, 2024 13:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Development

Successfully merging this pull request may close these issues.

1 participant