Skip to content

Commit

Permalink
Release version 0.4.0
Browse files Browse the repository at this point in the history
  • Loading branch information
thiell committed Feb 17, 2023
1 parent 5d2a2c5 commit ad5b45c
Show file tree
Hide file tree
Showing 11 changed files with 65 additions and 55 deletions.
12 changes: 6 additions & 6 deletions doc/man/man1/sas_counters.1
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
.TH SAS_COUNTERS 1 "2022-11-14" "0.3.13" "sasutils"
.SH NAME
sas_counters \- show Serial Attached SCSI (SAS) counters
.
.nr rst2man-indent-level 0
.
Expand Down Expand Up @@ -30,6 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SAS_COUNTERS" 1 "2023-02-16" "0.4.0" "sasutils"
.SH NAME
sas_counters \- show Serial Attached SCSI (SAS) counters
.SH SYNOPSIS
.sp
\fBsas_counters [\-h] [\-\-prefix PREFIX]\fP
Expand All @@ -44,12 +44,12 @@ for Carbon/Graphite with SAS topology information.
.B optional arguments:
.INDENT 7.0
.TP
.B \-h\fP,\fB \-\-help
.B \-h\fP,\fB \-\-help
show this help message and exit
.TP
.BI \-\-prefix \ PREFIX
carbon prefix (example: "datacenter.cluster", default is
"sasutils.sas_counters")
carbon prefix (example: \(dqdatacenter.cluster\(dq, default is
\(dqsasutils.sas_counters\(dq)
.UNINDENT
.UNINDENT
.SH EXIT STATUS
Expand Down
29 changes: 16 additions & 13 deletions doc/man/man1/sas_devices.1
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
.TH SAS_DEVICES 1 "2022-11-14" "0.3.13" "sasutils"
.SH NAME
sas_devices \- show Serial Attached SCSI (SAS) enclosures and devices
.
.nr rst2man-indent-level 0
.
Expand Down Expand Up @@ -30,26 +27,30 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SAS_DEVICES" 1 "2023-02-16" "0.4.0" "sasutils"
.SH NAME
sas_devices \- show Serial Attached SCSI (SAS) enclosures and devices
.SH SYNOPSIS
.sp
\fBsas_devices [\-h] [\-v]\fP
\fBsas_devices [\-h] [\-vv]\fP
.SH DESCRIPTION
.sp
\fBsas_devices\fP shows SAS devices and automatically resolves common associated
enclosures (no configuration required). Useful to check cabling and hardware
setup. When used with \fI\-v\fP, \fBsas_devices\fP will also display all disk devices
with serial numbers.
\fBsas_devices\fP shows SAS devices and automatically resolves multiple paths and
common associated enclosures (no configuration required). Useful to check
cabling and hardware setup. When used with \fI\-v\fP, \fBsas_devices\fP will also
display all disk devices with serial numbers. Adding a second \fI\-v\fP will display
additional information like some sysfs paths involved.
.SH OPTIONS
.INDENT 0.0
.TP
.B optional arguments:
.INDENT 7.0
.TP
.B \-h\fP,\fB \-\-help
.B \-h\fP,\fB \-\-help
show this help message and exit
.TP
.B \-v\fP,\fB \-\-verbose
enable verbose output
.B \-v\fP,\fB \-\-verbose
verbosity level, repeat multiple times!
.UNINDENT
.UNINDENT
.SH EXIT STATUS
Expand All @@ -59,11 +60,13 @@ An exit status of zero indicates success of the command, and failure otherwise.
.sp
\fBsas_counters\fP(1), \fBsas_discover\fP(1), \fBses_report\fP(1)
.SH BUG REPORTS
.sp
Use the following URL to submit a bug report or feedback:
.INDENT 0.0
.TP
.B Use the following URL to submit a bug report or feedback:
.INDENT 3.5
\fI\%https://github.com/stanford\-rc/sasutils/issues\fP
.UNINDENT
.UNINDENT
.SH AUTHOR
Stephane Thiell <[email protected]>
.SH COPYRIGHT
Expand Down
18 changes: 9 additions & 9 deletions doc/man/man1/sas_discover.1
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
.TH SAS_DISCOVER 1 "2022-11-14" "0.3.13" "sasutils"
.SH NAME
sas_discover \- display Serial Attached SCSI (SAS) topology
.
.nr rst2man-indent-level 0
.
Expand Down Expand Up @@ -30,6 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SAS_DISCOVER" 1 "2023-02-16" "0.4.0" "sasutils"
.SH NAME
sas_discover \- display Serial Attached SCSI (SAS) topology
.SH SYNOPSIS
.sp
\fBsas_discover [\-h] [\-\-verbose] [\-\-addr] [\-\-devices] [\-\-counters]\fP
Expand All @@ -38,7 +38,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
\fBsas_discover\fP displays the SAS topology from the host initiator(s), through
any SAS expanders up to the SAS targets. Each link usually represents a SAS
port connection, whether it uses one or more PHYs. The number of PHYs per port
is explicitly shown if greater than one (eg. "\-\-4x\-\-" for a 4\-PHY wide port).
is explicitly shown if greater than one (eg. \(dq\-\-4x\-\-\(dq for a 4\-PHY wide port).
Please note that by default, \fBsas_discover\fP tries to fold common devices
(like disks), like in the example below:
.INDENT 0.0
Expand Down Expand Up @@ -66,19 +66,19 @@ topology.
.B optional arguments:
.INDENT 7.0
.TP
.B \-h\fP,\fB \-\-help
.B \-h\fP,\fB \-\-help
show this help message and exit
.TP
.B \-\-verbose\fP,\fB \-v
.B \-\-verbose\fP,\fB \-v
Verbosity level, repeat multiple times!
.TP
.B \-\-addr
.B \-\-addr
Print SAS addresses
.TP
.B \-\-devices
.B \-\-devices
Print associated devices
.TP
.B \-\-counters
.B \-\-counters
Print I/O counters
.UNINDENT
.UNINDENT
Expand Down
20 changes: 10 additions & 10 deletions doc/man/man1/ses_report.1
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
.TH SES_REPORT 1 "2022-11-14" "0.3.13" "sasutils"
.SH NAME
ses_report \- SCSI Enclosure Services (SES) status and metrics reporting utility
.
.nr rst2man-indent-level 0
.
Expand Down Expand Up @@ -30,6 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SES_REPORT" 1 "2023-02-16" "0.4.0" "sasutils"
.SH NAME
ses_report \- SCSI Enclosure Services (SES) status and metrics reporting utility
.SH SYNOPSIS
.sp
\fBses_report [\-h] [\-d] (\-c | \-s) [\-\-prefix PREFIX] [\-j]\fP
Expand All @@ -50,28 +50,28 @@ Descriptors.
.B optional arguments:
.INDENT 7.0
.TP
.B \-h\fP,\fB \-\-help
.B \-h\fP,\fB \-\-help
show this help message and exit
.TP
.B \-d\fP,\fB \-\-debug
.B \-d\fP,\fB \-\-debug
enable debugging
.TP
.B \-c\fP,\fB \-\-carbon
.B \-c\fP,\fB \-\-carbon
output SES Element descriptors metrics in a format suitable
for Carbon/Graphite
.TP
.B \-s\fP,\fB \-\-status
.B \-s\fP,\fB \-\-status
output status found in SES Element descriptors
.UNINDENT
.TP
.B output options:
.INDENT 7.0
.TP
.BI \-\-prefix \ PREFIX
carbon prefix (example: "datacenter.cluster", default is
"sasutils.ses_report")
carbon prefix (example: \(dqdatacenter.cluster\(dq, default is
\(dqsasutils.ses_report\(dq)
.TP
.B \-j\fP,\fB \-\-json
.B \-j\fP,\fB \-\-json
alternative JSON output mode
.UNINDENT
.UNINDENT
Expand Down
4 changes: 2 additions & 2 deletions doc/txt/sas_counters.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ show Serial Attached SCSI (SAS) counters
----------------------------------------

:Author: Stephane Thiell <[email protected]>
:Date: 2022-11-14
:Date: 2023-02-16
:Copyright: Apache License Version 2.0
:Version: 0.3.13
:Version: 0.4.0
:Manual section: 1
:Manual group: sasutils

Expand Down
17 changes: 9 additions & 8 deletions doc/txt/sas_devices.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,33 +7,34 @@ show Serial Attached SCSI (SAS) enclosures and devices
------------------------------------------------------

:Author: Stephane Thiell <[email protected]>
:Date: 2022-11-14
:Date: 2023-02-16
:Copyright: Apache License Version 2.0
:Version: 0.3.13
:Version: 0.4.0
:Manual section: 1
:Manual group: sasutils


SYNOPSIS
========

``sas_devices [-h] [-v]``
``sas_devices [-h] [-vv]``

DESCRIPTION
===========


``sas_devices`` shows SAS devices and automatically resolves common associated
enclosures (no configuration required). Useful to check cabling and hardware
setup. When used with `-v`, ``sas_devices`` will also display all disk devices
with serial numbers.
``sas_devices`` shows SAS devices and automatically resolves multiple paths and
common associated enclosures (no configuration required). Useful to check
cabling and hardware setup. When used with `-v`, ``sas_devices`` will also
display all disk devices with serial numbers. Adding a second `-v` will display
additional information like some sysfs paths involved.

OPTIONS
=======

optional arguments:
-h, --help show this help message and exit
-v, --verbose enable verbose output
-v, --verbose verbosity level, repeat multiple times!

EXIT STATUS
===========
Expand Down
4 changes: 2 additions & 2 deletions doc/txt/sas_discover.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ display Serial Attached SCSI (SAS) topology
-------------------------------------------

:Author: Stephane Thiell <[email protected]>
:Date: 2022-11-14
:Date: 2023-02-16
:Copyright: Apache License Version 2.0
:Version: 0.3.13
:Version: 0.4.0
:Manual section: 1
:Manual group: sasutils

Expand Down
4 changes: 2 additions & 2 deletions doc/txt/ses_report.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ SCSI Enclosure Services (SES) status and metrics reporting utility
------------------------------------------------------------------

:Author: Stephane Thiell <[email protected]>
:Date: 2022-11-14
:Date: 2023-02-16
:Copyright: Apache License Version 2.0
:Version: 0.3.13
:Version: 0.4.0
:Manual section: 1
:Manual group: sasutils

Expand Down
3 changes: 3 additions & 0 deletions sasutils-el7.spec
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,9 @@ install -p -m 0644 doc/man/man1/ses_report.1 %{buildroot}/%{_mandir}/man1/
%license LICENSE.txt

%changelog
* Thu Feb 16 2023 Stephane Thiell <[email protected]> 0.4.0-1
- update version

* Mon Nov 14 2022 Stephane Thiell <[email protected]> 0.3.13-1
- update version

Expand Down
5 changes: 4 additions & 1 deletion sasutils.spec
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Name: sasutils
Version: 0.3.13
Version: 0.4.0
Release: 1%{?dist}
Summary: Serial Attached SCSI (SAS) utilities

Expand Down Expand Up @@ -51,6 +51,9 @@ install -p -m 0644 doc/man/man1/ses_report.1 %{buildroot}/%{_mandir}/man1/
%license LICENSE.txt

%changelog
* Thu Feb 16 2023 Stephane Thiell <[email protected]> 0.4.0-1
- update version

* Mon Nov 14 2022 Stephane Thiell <[email protected]> 0.3.13-1
- update version

Expand Down
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#
# Copyright (C) 2016, 2017, 2018, 2019, 2021, 2022
# Copyright (C) 2016, 2017, 2018, 2019, 2021, 2022, 2023
# The Board of Trustees of the Leland Stanford Junior University
# Written by Stephane Thiell <[email protected]>
#
Expand All @@ -17,7 +17,7 @@

from setuptools import setup, find_packages

VERSION = '0.3.13'
VERSION = '0.4.0'

setup(name='sasutils',
version=VERSION,
Expand Down

0 comments on commit ad5b45c

Please sign in to comment.