Skip to content

Commit

Permalink
Dev: doc: Rename hb_report as crm report
Browse files Browse the repository at this point in the history
  • Loading branch information
liangxin1300 committed Dec 23, 2021
1 parent 8cd9b41 commit e653956
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ crmconf_DATA = etc/crm.conf etc/profiles.yml
contribdir = $(docdir)/contrib
contrib_DATA = contrib/pcmk.vim contrib/README.vimsyntax
helpdir = $(datadir)/$(PACKAGE)
asciiman = doc/crm.8.adoc doc/crmsh_hb_report.8.adoc doc/profiles.adoc
asciiman = doc/crm.8.adoc doc/crmsh_crm_report.8.adoc doc/profiles.adoc
help_DATA = doc/crm.8.adoc

generated_docs =
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ included in the repository.
./test: unit tests and regression tests
./contrib: vim highlighting scripts and other semi-related
contributions
./hb_report: log file collection and analysis tool
./crm report: log file collection and analysis tool
```

## Development
Expand Down
2 changes: 1 addition & 1 deletion crmsh.spec.in
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ result2=$?
%{crmsh_docdir}/COPYING
%{crmsh_docdir}/AUTHORS
%{crmsh_docdir}/crm.8.html
%{crmsh_docdir}/crmsh_hb_report.8.html
%{crmsh_docdir}/crmsh_crm_report.8.html
%{crmsh_docdir}/profiles.html
%{crmsh_docdir}/ChangeLog
%{crmsh_docdir}/README.md
Expand Down
8 changes: 4 additions & 4 deletions doc/crm.8.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4697,7 +4697,7 @@ history commands look at events within a certain time span.

For the `live` source, the default time span is the _last hour_.

There is no time span limit for the `hb_report` source.
There is no time span limit for the `crm report` source.

The time period is parsed by the `dateutil` python module. It
covers a wide range of date formats. For instance:
Expand Down Expand Up @@ -4833,7 +4833,7 @@ current settings can be saved and later retrieved.
If the current history being examined is coming from a live
cluster the logs, PE inputs, and other files are saved too,
because they may disappear from nodes. For the existing reports
coming from `hb_report`, only the directory location is saved
coming from `crm report`, only the directory location is saved
(not to waste space).

A history session may also be packed into a tarball which can
Expand Down Expand Up @@ -4890,7 +4890,7 @@ show pe-input-2080.bz2 status
==== `source`

Events to be examined can come from the current cluster or from a
`hb_report` report. This command sets the source. `source live`
`crm report` report. This command sets the source. `source live`
sets source to the running cluster and system logs. If no source
is specified, the current source information is printed.

Expand Down Expand Up @@ -5024,7 +5024,7 @@ and other relevant data for a given time period. This is a useful tool
for collecting data to attach to bug reports, or for detecting the
root cause of errors resulting in resource failover, for example.

See `crmsh_hb_report(8)` for more details on arguments,
See `crmsh_crm_report(8)` for more details on arguments,
or call `crm report -h`

Usage:
Expand Down
12 changes: 6 additions & 6 deletions doc/crmsh_hb_report.8.adoc → doc/crmsh_crm_report.8.adoc
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
:man source: crmsh_hb_report
:man source: crmsh_crm_report
:man version: 1.2
:man manual: Pacemaker documentation

crmsh_hb_report(8)
crmsh_crm_report(8)
==================

NAME
----
crmsh_hb_report - create report for CRM based clusters (Pacemaker)
crmsh_crm_report - create report for CRM based clusters (Pacemaker)


SYNOPSIS
Expand All @@ -19,7 +19,7 @@ SYNOPSIS

DESCRIPTION
-----------
The crmsh_hb_report(8) is a utility to collect all information (logs,
The crmsh_crm_report(8) is a utility to collect all information (logs,
configuration files, system information, etc) relevant to
Pacemaker (CRM) over the given period of time.

Expand All @@ -29,8 +29,8 @@ OPTIONS
dest::
The report name. It can also contain a path where to put the
report tarball. If left out, the tarball is created in the
current directory named "hb_report-current_date", for instance
hb_report-Wed-03-Mar-2010.
current directory named "crm_report-current_date", for instance
crm_report-Wed-03-Mar-2010.

*-d*::
Don't create the compressed tar, but leave the result in a
Expand Down

0 comments on commit e653956

Please sign in to comment.