diff --git a/Makefile.am b/Makefile.am index c9debab417..0af5a6cde4 100644 --- a/Makefile.am +++ b/Makefile.am @@ -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 = diff --git a/README.md b/README.md index 5e8c526be9..6ca02b6a6f 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/crmsh.spec.in b/crmsh.spec.in index 4a66282e59..fa011adff9 100644 --- a/crmsh.spec.in +++ b/crmsh.spec.in @@ -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 diff --git a/doc/crm.8.adoc b/doc/crm.8.adoc index a8bd2ea0d0..b90d263aa5 100644 --- a/doc/crm.8.adoc +++ b/doc/crm.8.adoc @@ -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: @@ -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 @@ -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. @@ -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: diff --git a/doc/crmsh_hb_report.8.adoc b/doc/crmsh_crm_report.8.adoc similarity index 98% rename from doc/crmsh_hb_report.8.adoc rename to doc/crmsh_crm_report.8.adoc index df9bdbfc16..98ef0a77d0 100644 --- a/doc/crmsh_hb_report.8.adoc +++ b/doc/crmsh_crm_report.8.adoc @@ -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 @@ -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. @@ -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