Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Markdown-ify the bladeRF-cli interactive help #270

Closed
wants to merge 5 commits into from

Conversation

rtucker
Copy link
Contributor

@rtucker rtucker commented Jul 4, 2014

Adds a new include, doc/cmd_help.h. This is generated by
pandoc from doc/interactive-help.md. It's ugly, but that's
why it's programatically generated.

CMake will either generate a new cmd_help.{h,man} or copy them
in from cmd_help.{h,man}.in if pandoc isn't available.

Update cmd.c to use all of these new #defines. (It looks
cleaner now...!)

Remove the old get-interactive-commands.bash, which is no longer
a part of the build process. pandoc also generates a man page
snippet for insertion by help2man.

Ryan Tucker added 3 commits July 4, 2014 17:31
Adds a new include, doc/cmd_help.h.  This is generated by
pandoc from doc/interactive-help.md.  It's ugly, but that's
why it's programatically generated.

CMake will either generate a new cmd_help.{h,man} or copy them
in from cmd_help.{h,man}.in if pandoc isn't available.

Update cmd.c to use all of these new #defines.  (It looks
cleaner now...!)

Remove the old get-interactive-commands.bash, which is no longer
a part of the build process.  pandoc also generates a man page
snippet for insertion by help2man.
@jynik jynik added this to the 2014.09-rc2 milestone Jul 5, 2014
@jynik jynik self-assigned this Jul 5, 2014
@bpadalino
Copy link
Contributor

There is a misspelling of parameter which was in the original text. Do you mind also quickly fixing that up?

@rtucker
Copy link
Contributor Author

rtucker commented Jul 5, 2014

There were a few misspellings from the original help texts and I didn't get all of them. I'm down in the boonies at a cookout but will run a spell check when I get home. 

-- 
Sent from a mobile device with amazing capabilities, including a profound ability to incorrectly guess what I meat to tripe.

-------- Original message --------
From: Brian Padalino notifications@github.com
Date:2014/07/05 18:14 (GMT-05:00)
To: Nuand/bladeRF bladeRF@noreply.github.com
Cc: Ryan Tucker github@ryantucker.us
Subject: Re: [bladeRF] Markdown-ify the bladeRF-cli interactive help (#270)
There is a (misspelling of parameter)[https://github.com//pull/270/files#diff-c001938a27c2f77410ddb80500413673R64] which was in the original text. Do you mind also quickly fixing that up?


Reply to this email directly or view it on GitHub.

Ryan Tucker added 2 commits July 5, 2014 20:50
lintian's man page check is picky enough that it was
grousing about:

1) "'`f_min`' and '`f_max`' are ..." occasionally appearing at the
   start of a line, thus being interpreted as groff macros due to
   the single quote.

2) The calibrate lms rxvga2 syntax line was not always wrapping
   properly.
@rtucker
Copy link
Contributor Author

rtucker commented Jul 6, 2014

Closing this pull request -- the number of commits was getting lengthy, so I re-rolled it into a single commit and re-submitted the pull request as #275.

@rtucker rtucker closed this Jul 6, 2014
@rtucker rtucker deleted the dev-help_and_man_fixes_cleaned branch February 8, 2018 20:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants