Skip to content

Commit

Permalink
markdownlint: enable rule MD003
Browse files Browse the repository at this point in the history
MD003 - Header style
Fixed all errors

Signed-off-by: Maciej Wawryk <maciejx.wawryk@intel.com>
Change-Id: Ic00d38a3fa0af16581598fd49dc2ee7e1632c9d8
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/9287
Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Community-CI: Mellanox Build Bot
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
  • Loading branch information
Maciej Wawryk authored and jimharris committed Sep 8, 2021
1 parent 111d427 commit cb85bf0
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 7 deletions.
9 changes: 3 additions & 6 deletions examples/blob/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,21 @@
The blobcli tool has several options that are listed by using the -h command
however the three operating modes are covered in more detail here:

Command Mode
------------
## Command Mode

This is the default and will just execute one command at a time. It's simple
but the downside is that if you are going to interact quite a bit with the
blobstore, the startup time for the application can be cumbersome.

Shell Mode
----------
## Shell Mode

You startup shell mode by using the -S command. At that point you will get
a "blob>" prompt where you can enter any of the commands, including -h,
to execute them. You can stil enter just one at a time but the initial
startup time for the application will not get in the way between commands
anymore so it is much more usable.

Script (aka test) Mode
----------------------
## Script (aka test) Mode

In script mode you just supply one command with a filename when you start
the cli, for example `blobcli -T test.bs` will feed the tool the file
Expand Down
1 change: 0 additions & 1 deletion mdl_rules.rb
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
all
exclude_rule 'MD003'
exclude_rule 'MD004'
exclude_rule 'MD010'
rule 'MD013', :line_length => 170
Expand Down

0 comments on commit cb85bf0

Please sign in to comment.