dmitriy.kazimirov/inxi
1
0
Fork 0
mirror of https://github.com/smxi/inxi.git synced 2024-11-16 16:21:39 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

readme edits

Browse source
This commit is contained in:
Harald Hope 2018-04-15 13:19:04 -07:00
parent e4fe538463
commit 112ef61348
1 changed files with 92 additions and 83 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

175
README.txt
View file

@ -5,14 +5,13 @@ branch. All support for versions prior to 2.9 is now ended, sorry.
Make sure to update to the current inxi from the master branch before Make sure to update to the current inxi from the master branch before
filing any issue reports. The code in pre 2.9 versions literally no filing any issue reports. The code in pre 2.9 versions literally no
longer exists in inxi 3. 3.0 was a full rewrite of inxi. Bugs from longer exists in inxi 3. Bugs from earlier versions cannot be solved
earlier versions cannot be solved in the new version since the the in the new version since the pre 2.9 and the 2.9 and later versions
pre 2.9 and the 2.9 and later versions are completely different are completely different internally.
internally.
inxi strives to support the widest range of operating systems and inxi strives to support the widest range of operating systems and
hardware, from the most simple consumer desktops, to the most advanced hardware, from the most simple consumer desktops, to the most advanced
professional hardware and servers, and various platforms. professional hardware and servers.
The issues you post help maintain or expand that support, and are The issues you post help maintain or expand that support, and are
always appreciated since user data and feedback is what keeps inxi always appreciated since user data and feedback is what keeps inxi
@ -58,6 +57,7 @@ wget -Nc https://github.com/smxi/inxi/raw/inxi-perl/pinxi
OR easy to remember shortcut (which redirects to github): OR easy to remember shortcut (which redirects to github):
wget -Nc https://smxi.org/pinxi wget -Nc https://smxi.org/pinxi
wget -Nc smxi.org/pinxi
Once new features have been debugged, tested, and are stable, they Once new features have been debugged, tested, and are stable, they
will move to the master branch. will move to the master branch.
@ -87,7 +87,7 @@ man page would show you, and do not ask for features to be added that
inxi already has. Also do not ask for support if your distro won't inxi already has. Also do not ask for support if your distro won't
update its inxi version, some are bad about that. update its inxi version, some are bad about that.
DOCUMENTATION: http://smxi.org/docs/inxi.htm DOCUMENTATION: https://smxi.org/docs/inxi.htm
(smxi.org/docs/ is easier to remember, and is one click away from (smxi.org/docs/ is easier to remember, and is one click away from
inxi.htm). The one page wiki on github is only a pointer to the real inxi.htm). The one page wiki on github is only a pointer to the real
resources. resources.
@ -99,7 +99,7 @@ Also has useful information about Perl version support, including the
list of Core modules that _should_ be included in a distribution's list of Core modules that _should_ be included in a distribution's
core modules, but which are unfortunately sometimes removed. core modules, but which are unfortunately sometimes removed.
HTML MAN PAGE: http://smxi.org/docs/inxi-man.htm HTML MAN PAGE: https://smxi.org/docs/inxi-man.htm
INXI OPTIONS PAGE: http://smxi.org/docs/inxi-options.htm INXI OPTIONS PAGE: http://smxi.org/docs/inxi-options.htm
NOTE: These may not always be up to date, but generally track the most NOTE: These may not always be up to date, but generally track the most
recent inxi commits. recent inxi commits.
@ -112,11 +112,11 @@ legacy inxi is not being supported since our time here on earth is
finite (plus of course, one reason for the rewrite was to never have finite (plus of course, one reason for the rewrite was to never have
to work with Gawk->Bash again!). to work with Gawk->Bash again!).
SUPPORT FORUMS: http://techpatterns.com/forums/forum-33.html SUPPORT FORUMS: https://techpatterns.com/forums/forum-33.html
This is the best place to place support issues that may be complicated. This is the best place to place support issues that may be complicated.
If you are developer, use: If you are developer, use:
DEVELOPER FORUMS: http://techpatterns.com/forums/forum-32.html DEVELOPER FORUMS: https://techpatterns.com/forums/forum-32.html
SOURCE VERSION CONTROL: https://github.com/smxi/inxi SOURCE VERSION CONTROL: https://github.com/smxi/inxi
MAIN BRANCH: master MAIN BRANCH: master
@ -144,8 +144,7 @@ inxi releases early, and releases often, when under development.
PACKAGERS: inxi has one and only one 'release', and that is the current PACKAGERS: inxi has one and only one 'release', and that is the current
commit to master branch (plus pinxi inxi-perl branch, of course, but commit to master branch (plus pinxi inxi-perl branch, of course, but
those should never be packaged). All previous commits are immediately those should never be packaged).
obsolete on the commit of every new commit.
===================================================================== =====================================================================
ABOUT INXI - CORE COMMITMENT TO LONG TERM STABILITY ABOUT INXI - CORE COMMITMENT TO LONG TERM STABILITY
@ -186,13 +185,13 @@ confirm things like ram capacity with a reputable hardware source,
like crucial.com, which has the best ram hardware tool I know of. like crucial.com, which has the best ram hardware tool I know of.
The core mission of inxi is to always work on all systems all the The core mission of inxi is to always work on all systems all the
time. Well, all linux systems with the core tools inxi requires to time. Well, all systems with the core tools inxi requires to operate
operate installed. Ie, not android, yet. What this means is this: installed. Ie, not Android, yet. What this means is this: you can
you can have a 10 year old box, or probably 15, not sure, and you have a 10 year old box, or probably 15, not sure, and you can install
can install today's inxi on it, and it will run. It won't run fast, today's inxi on it, and it will run. It won't run fast, but it will
but it will run. I test inxi on a 200 MHz laptop from about 1998 run. I test inxi on a 200 MHz laptop from about 1998 to keep it
to keep it honest. That's also what was used to optimize the code at honest. That's also what was used to optimize the code at some
some points, since differences appear as seconds, not 10ths or 100ths points, since differences appear as seconds, not 10ths or 100ths
of seconds on old systems like that. of seconds on old systems like that.
inxi is being written, and tested, on Perl as old as 5.08, and will inxi is being written, and tested, on Perl as old as 5.08, and will
@ -268,91 +267,101 @@ platform, etc.
===================================================================== =====================================================================
INXI RELEASE/SUPPORT/ISSUES/BUGS INFORMATION: INXI RELEASE/SUPPORT/ISSUES/BUGS INFORMATION:
Important: the only version of inxi that is supported is the latest current Important: the only version of inxi that is supported is the latest
master branch release. No issue reports or bug reports will be accepted for current master branch release. No issue reports or bug reports will be
anything other than current master branch. No merges, attempts to patch old code accepted for anything other than current master branch. No merges,
from old releases, will be considered or accepted. If you are not updated to attempts to patch old code from old releases, will be considered or
the latest inxi, do not file a bug report since it's probably been fixed ages accepted. If you are not updated to the latest inxi, do not file a
ago. If your distro isn't packaging a current inxi, then file a bug report bug report since it's probably been fixed ages ago. If your distro
with them, not here. The only valid working code base for inxi is the current isn't packaging a current inxi, then file a bug report with them, not
here. The only valid working code base for inxi is the current
release of inxi. release of inxi.
Distributions should never feel any advantage comes from using old inxi Distributions should never feel any advantage comes from using old
releases because inxi has as a core promise to you, the end user, that it inxi releases because inxi has as a core promise to you, the end user,
will NEVER require new tools to run. New tools may be required for a new that it will NEVER require new tools to run. New tools may be required
feature, but that will always be handled internally by inxi, and will not cause for a new feature, but that will always be handled internally by inxi,
any operational failures. This is a promise, and I will never as long as I run and will not cause any operational failures. This is a promise, and I
this project violate that core inxi requirement. Old inxi is NOT more stable will never as long as I run this project violate that core inxi
than current inxi, it's just old, and lacking in bug fixes and features. For requirement. Old inxi is NOT more stable than current inxi, it's just
pre 2.9 releases, it's also significantly slower, and with fewer features. old, and lacking in bug fixes and features. For pre 2.9 releases, it's
also significantly slower, and with fewer features.
inxi is a rolling release codebase, just like Debian Sid, Gentoo, or Arch inxi is a rolling release codebase, just like Debian Sid, Gentoo, or
Linux are rolling release GNU/Linux distributions, with no 'release points'. Arch Linux are rolling release GNU/Linux distributions, with no
'release points'.
Your distro not updating inxi ever, then failing to show something that is Your distro not updating inxi ever, then failing to show something
fixed in current inxi is not a bug, and please do not post it here. File that is fixed in current inxi is not a bug, and please do not post it
the issue with your distro, not here. Updating inxi in a package pool will here. File the issue with your distro, not here. Updating inxi in a
NEVER make anything break or fail, period. It has no version based package pool will NEVER make anything break or fail, period. It has no
dependencies, just software, like Perl 5.xx, lspci, etc. There is never a valid version based dependencies, just software, like Perl 5.xx, lspci, etc.
reason to not update inxi in a package pool of any distro in the world (with There is never a valid reason to not update inxi in a package pool of
one single known exception, the Slackware based Puppy Linux release, which any distro in the world (with one single known exception, the Slackware
ships without the full Perl language. The Debian based one works fine). based Puppy Linux release, which ships without the full Perl language.
The Debian based one works fine).
Sys Admin type inxi users always get the first level of support. ie, convince Sys Admin type inxi users always get the first level of support. ie,
us you run real systems and networks, and your issue shoots to the top of convince us you run real systems and networks, and your issue shoots
the line. As do any real bugs. Failure to supply requested debugger data to the top of the line. As do any real bugs. Failure to supply
will lead to a distinct lack of interest on our part to help you with a requested debugger data will lead to a distinct lack of interest on
bug. ie, saying, oh, x doesn't work, doesn't cut it, unless it's obvious why. our part to help you with a bug. ie, saying, oh, x doesn't work,
doesn't cut it, unless it's obvious why.
===================================================================== =====================================================================
INXI VERSION NUMBERING: INXI VERSION NUMBERING:
inxi uses 'semantic' version numbering, where the version numbers actually inxi uses 'semantic' version numbering, where the version numbers
mean something. actually mean something.
The version number follows these guidelines: The version number follows these guidelines:
Using example 3.2.28-6 Using example 3.2.28-6
The first digit(s), "3", is a major version, and almost never changes. Only The first digit(s), "3", is a major version, and almost never changes.
a huge milestone, or if inxi reaches 3.9.xx, when it will simply move up to Only a huge milestone, or if inxi reaches 3.9.xx, when it will simply
4.0.0 just to keep it clean, would cause a change. move up to 4.0.0 just to keep it clean, would cause a change.
The second digit(s), "2", means a new real feature has been added. Not a The second digit(s), "2", means a new real feature has been added.
tweaked existing feature, an actual new feature, which usually also has a new Not a tweaked existing feature, an actual new feature, which usually
argument option letter attached. The second number goes from 0 to 9, and then also has a new argument option letter attached. The second number goes
rolls over the first after 9. It could also be adding a very complicated from 0 to 9, and then rolls over the first after 9. It could also be
expansion of existing features, like Wayland. It depends. adding a very complicated expansion of existing features, like Wayland.
It depends.
The third, "28", is for everything small, can cover bug fixes, tweaks to The third, "28", is for everything small, can cover bug fixes, tweaks
existing features to add support for something, pretty much anything where you to existing features to add support for something, pretty much anything
want the end user to know that they are not up to date. The third goes from 0 where you want the end user to know that they are not up to date. The
to 99, then rolls over the second. third goes from 0 to 99, then rolls over the second.
The fourth, "6", is extra information about certain types of inxi updates. The fourth, "6", is extra information about certain types of inxi
I don't usually use this last one in master branch, but you will see it updates. I don't usually use this last one in master branch, but you
in branches one,two, inxi-perl, inxi-legacy since that is used to confirm will see it in branches one,two, inxi-perl, inxi-legacy since that is
remote test system patch version updates. used to confirm remote test system patch version updates.
The fourth number, when used, will be alpha-numeric, a common version would be, The fourth number, when used, will be alpha-numeric, a common version
in say, branch one: 2.2.28-b1-02, in other words, a branch 1 release, version 2. would be, in say, branch one: 2.2.28-b1-02, in other words, a branch 1
release, version 2.
In the past, now and then the 4th, or 'patch', number, was used in trunk/master In the past, now and then the 4th, or 'patch', number, was used in
branches of inxi, but I've pretty much stopped doing that because it's confusing. trunk/master branches of inxi, but I've pretty much stopped doing that
because it's confusing.
inxi does not use the fiction of date based versioning because that imparts no inxi does not use the fiction of date based versioning because that
useful information to the end user, when you look at say, 2.2.28, and you last imparts no useful information to the end user, when you look at say,
had 2.2.11, you can know with some certainty that inxi has no major new 2.2.28, and you last had 2.2.11, you can know with some certainty that
features, just fine tunings and bug fixes. And if you see one with 2.3.2, you inxi has no major new features, just fine tunings and bug fixes. And
will know that there is a new feature, almost, but not always, linked to one if you see one with 2.3.2, you will know that there is a new feature,
or more new line output items. Sometimes a fine tuning can be quite almost, but not always, linked to one or more new line output items.
significant, sometimes it's a one line code fix. Sometimes a fine tuning can be quite significant, sometimes it's a
one line code fix.
A move to a new full version number, like the rewrite of inxi to Perl, would A move to a new full version number, like the rewrite of inxi to Perl,
reflect in first version say, 2.9.01, then after a period of testing, where would reflect in first version say, 2.9.01, then after a period of
most little glitches are fixed, a move to 3.0.0. These almost never happen. testing, where most little glitches are fixed, a move to 3.0.0. These
I do not expect for example version 4.0 to ever happen after the 3.0 release almost never happen. I do not expect for example version 4.0 to ever
of early 2018, unless so many new features are added that it actually hits 3.9, happen after the 3.0 release of early 2018, unless so many new
then it would roll over to 4. features are added that it actually hits 3.9, then it would roll
over to 4.
### EOF ### ### EOF ###