Skip to content

Wip/bewest/help output #87

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.

Sign up for GitHub

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

Jump to bottom
Merged
bewest merged 17 commits into from
Apr 8, 2016
Merged

Wip/bewest/help output #87

bewest merged 17 commits into from
Apr 8, 2016

Conversation

@bewest
Copy link
Member

@bewest bewest commented Mar 24, 2016

Bless all tools with -h flag.

Allows using something like this to generate docs:

$ cat mktool-ref.sh 
#!/bin/bash


OPENAPS_HOME=${1-~/Documents/openaps}
PREFIX=${2-openaps}
OUTPUT=${3-source/reference}
OUTDIR=$OUTPUT/$PREFIX
compgen -c $PREFIX | while read tool ; do
  if [[ -x $(which $tool) ]] ; then
  OUTFILE=$OUTDIR/$tool.md
  (
    mkdir -p $OUTDIR

    echo "# \`$tool\`"
    echo
    echo "## Help"
    (cd $OPENAPS_HOME
      $tool --help
    )

  ) | tee $OUTFILE
  fi
done

@bewest
more easily print to stdout
e816051
@bewest
add some docs to the tool
b078f1e
@bewest
ensure --help output for all tools
ed81549
@bewest
Merge branch 'dev' of github.com:openaps/oref0 into wip/bewest/import…
20c1abf 
…-utils

Catch up to dev.
Conflicts:
	bin/oref0-determine-basal.js
	bin/oref0-pebble.js
@bewest
switch from sh to bash, fix bashisms
595264f 
Make the bashisms like more traditional function definitions work.
Fixes some syntax errors for things that work in bash but not sh.
@bewest bewest mentioned this pull request Mar 25, 2016
Merged
@bewest
Copy link
Member Author

bewest commented Mar 30, 2016

Bringing branch up to date with dev for consideration.

This mainly tries to make sure that every single tool does something simple when -h or --help is given.

bewest added 4 commits March 30, 2016 14:19
@bewest
if ENTRIES is supposed to be a file, fail if empty/missing
c0915b7
@bewest
make Nightscout tools a lot easier to use in openaps.
13fec3c 
This can now autoconfigure a basic CRUD via ns-upload and ns-get so that they
both work under the same config.  Should make setting up some NS things a bit
easier.
@bewest
make sure ns-get does something in host mode
032c2fd
@bewest
stub out openaps template generator
bb34d79
@bewest
Copy link
Member Author

bewest commented Apr 2, 2016

See also:

scottleibrand
scottleibrand reviewed Apr 3, 2016
View reviewed changes
bin/mm-format-ns-profile.sh
SENSITIVITIES=${4-monitor/insulin-sensitivities.json}
TARGETS=${5-monitor/bg-targets.json}
OUTPUT=${6-settings/ns-profile.json}
OUTPUT=${6-/dev/fd/1}
Copy link
Contributor

@scottleibrand scottleibrand Apr 3, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is this change?

Copy link
Member Author

@bewest bewest Apr 3, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where to cat the results (- aka, stdout is also named /dev/fd/1) Many tools allow for an --output - or any other file, this is the bashism to do that.

@scottleibrand
Copy link
Contributor

scottleibrand commented Apr 3, 2016

One question (line comment) on bin/mm-format-ns-profile.sh. Otherwise 👍

@bewest bewest merged commit 1a57bb9 into dev Apr 8, 2016
@bewest bewest deleted the wip/bewest/help-output branch April 8, 2016 23:52
@bewest bewest mentioned this pull request May 15, 2016
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@bewest @scottleibrand