mirror of
https://github.com/smxi/inxi.git
synced 2024-11-16 16:21:39 +00:00
readme update
This commit is contained in:
parent
48b569eb95
commit
a21a662623
482
README.txt
482
README.txt
|
@ -1,32 +1,29 @@
|
||||||
README for inxi - a command line system information tool
|
README for inxi - a command line system information tool
|
||||||
|
|
||||||
The new Perl inxi is now here! File all issue reports with the master
|
The new Perl inxi is now here! File all issue reports with the master branch.
|
||||||
branch. All support for versions prior to 3.0 is now ended, sorry.
|
All support for versions prior to 3.0 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
|
||||||
filing any issue reports. The code in pre 2.9 versions literally no
|
any issue reports. The code in pre 2.9 versions literally no longer exists in
|
||||||
longer exists in inxi 3. Bugs from earlier versions cannot be solved
|
inxi 3. Bugs from earlier versions cannot be solved in the new version since
|
||||||
in the new version since the pre 2.9 and the 2.9 and later versions
|
the pre 2.9 and the 2.9 and later versions are completely different internally.
|
||||||
are completely different internally.
|
|
||||||
|
|
||||||
inxi strives to support the widest range of operating systems and
|
inxi strives to support the widest range of operating systems and hardware,
|
||||||
hardware, from the most simple consumer desktops, to the most advanced
|
from the most simple consumer desktops, to the most advanced professional
|
||||||
professional hardware and servers.
|
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
|
||||||
always appreciated since user data and feedback is what keeps inxi
|
appreciated since user data and feedback is what keeps inxi working and
|
||||||
working and supporting the latest or not so latest hardware and
|
supporting the latest or not so latest hardware and operating systems.
|
||||||
operating systems.
|
|
||||||
|
|
||||||
See the BSD section below for qualifications re BSDs, and OSX in
|
See the BSD section below for qualifications re BSDs, and OSX in particular.
|
||||||
particular.
|
|
||||||
|
|
||||||
=====================================================================
|
===============================================================================
|
||||||
MASTER BRANCH:
|
MASTER BRANCH:
|
||||||
|
|
||||||
This is the only supported branch, and the current latest commit is
|
This is the only supported branch, and the current latest commit/version is
|
||||||
the only supported 'release'. There are no 'releases' of inxi beyond
|
the only supported 'release'. There are no 'releases' of inxi beyond the
|
||||||
the current commit to master. All past commits are not supported.
|
current commit/version in master. All past versions are not supported.
|
||||||
|
|
||||||
git clone https://github.com/smxi/inxi --branch master --single-branch
|
git clone https://github.com/smxi/inxi --branch master --single-branch
|
||||||
|
|
||||||
|
@ -37,18 +34,18 @@ OR easy to remember shortcut (which redirects to github):
|
||||||
wget -Nc https://smxi.org/inxi
|
wget -Nc https://smxi.org/inxi
|
||||||
wget -Nc smxi.org/inxi
|
wget -Nc smxi.org/inxi
|
||||||
|
|
||||||
'Tagging' is purely a formality that certain distros can't figure out
|
'Tagging' is purely a formality that certain distros can't figure out how to
|
||||||
how to do without, that's all. A tag is a pointer to a commit, and has
|
do without, that's all. A tag is a pointer to a commit, and has no further
|
||||||
no further meaning.
|
meaning.
|
||||||
|
|
||||||
NOTE: Just because github calls tagged commits 'Releases' does not
|
NOTE: Just because github calls tagged commits 'Releases' does not mean they
|
||||||
mean they are releases! I can't change the words on the tag page.
|
are releases! I can't change the words on the tag page. They are tagged
|
||||||
They are tagged commmits, period. I did not want to use tags precisely
|
commmits, period. I did not want to use tags precisely to avoid the idea that
|
||||||
to avoid the idea that inxi has any release that exists that is other
|
inxi has any 'release' that exists that is other than the current master
|
||||||
than it's current master version, but I decided that it was less pain
|
version, but I decided that it was less pain to add tags than to argue this
|
||||||
to add tags than to argue this point any further.
|
point any further.
|
||||||
|
|
||||||
=====================================================================
|
===============================================================================
|
||||||
DEVELOPMENT BRANCH:
|
DEVELOPMENT BRANCH:
|
||||||
All active development is now done on the inxi-perl branch (pinxi):
|
All active development is now done on the inxi-perl branch (pinxi):
|
||||||
|
|
||||||
|
@ -61,13 +58,13 @@ 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
|
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
|
||||||
will move to the master branch.
|
to the master branch.
|
||||||
|
|
||||||
=====================================================================
|
===============================================================================
|
||||||
LEGACY BRANCH:
|
LEGACY BRANCH:
|
||||||
If you'd like to look at or check out the Gawk/Bash version of inxi,
|
If you'd like to look at or check out the Gawk/Bash version of inxi, you can
|
||||||
you can find it here, at the inxi-legacy branch (binxi):
|
find it here, at the inxi-legacy branch (binxi):
|
||||||
|
|
||||||
git clone https://github.com/smxi/inxi --branch inxi-legacy --single-branch
|
git clone https://github.com/smxi/inxi --branch inxi-legacy --single-branch
|
||||||
|
|
||||||
|
@ -77,42 +74,40 @@ wget -Nc https://github.com/smxi/inxi/raw/inxi-legacy/binxi
|
||||||
OR easy to remember shortcut (which redirects to github):
|
OR easy to remember shortcut (which redirects to github):
|
||||||
wget -Nc https://smxi.org/binxi
|
wget -Nc https://smxi.org/binxi
|
||||||
|
|
||||||
This version will not be maintained, and it's unlikely that any time
|
This version will not be maintained, and it's unlikely that any time will be
|
||||||
will be spent on it in the future, but it is there in case it's of
|
spent on it in the future, but it is there in case it's of use or interest to
|
||||||
use or interest to anyone.
|
anyone.
|
||||||
|
|
||||||
=====================================================================
|
===============================================================================
|
||||||
SUPPORT INFO:
|
SUPPORT INFO:
|
||||||
|
|
||||||
Do not ask for basic help that reading the inxi -h / --help menus, or
|
Do not ask for basic help that reading the inxi -h / --help menus, or man page
|
||||||
man page would show you, and do not ask for features to be added that
|
would show you, and do not ask for features to be added that inxi already has.
|
||||||
inxi already has. Also do not ask for support if your distro won't
|
Also do not ask for support if your distro won't update its inxi version, some
|
||||||
update its inxi version, some are bad about that.
|
are bad about that.
|
||||||
|
|
||||||
DOCUMENTATION: https://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).
|
||||||
inxi.htm). The one page wiki on github is only a pointer to the real
|
The one page wiki on github is only a pointer to the real resources.
|
||||||
resources.
|
|
||||||
|
|
||||||
https://github.com/smxi/inxi/tree/inxi-perl/docs
|
https://github.com/smxi/inxi/tree/inxi-perl/docs
|
||||||
Contains specific Perl inxi documentation, of interest mostly to
|
Contains specific Perl inxi documentation, of interest mostly to developers.
|
||||||
developers. Includes internal inxi tools, values, configuration items.
|
Includes internal inxi tools, values, configuration items. Also has useful
|
||||||
Also has useful information about Perl version support, including the
|
information about Perl version support, including the list of Core modules that
|
||||||
list of Core modules that _should_ be included in a distribution's
|
_should_ be included in a distribution's core modules, but which are
|
||||||
core modules, but which are unfortunately sometimes removed.
|
unfortunately sometimes removed.
|
||||||
|
|
||||||
HTML MAN PAGE: https://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
|
||||||
recent inxi commits.
|
inxi commits.
|
||||||
|
|
||||||
ISSUES: https://github.com/smxi/inxi/issues
|
ISSUES: https://github.com/smxi/inxi/issues
|
||||||
No issues accepted for non current inxi releases. See below for more on
|
No issues accepted for non current inxi versions. See below for more on that.
|
||||||
that. Unfortunately as of 2.9, no support or issues can be accepted for
|
Unfortunately as of 2.9, no support or issues can be accepted for older inxi's
|
||||||
older inxi's because inxi 2.9 (Perl) and newer is a full rewrite, and
|
because inxi 2.9 (Perl) and newer is a full rewrite, and legacy inxi is not
|
||||||
legacy inxi is not being supported since our time here on earth is
|
being supported since our time here on earth is finite (plus of course, one
|
||||||
finite (plus of course, one reason for the rewrite was to never have
|
reason for the rewrite was to never have to work with Gawk->Bash again!).
|
||||||
to work with Gawk->Bash again!).
|
|
||||||
|
|
||||||
SUPPORT FORUMS: https://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.
|
||||||
|
@ -123,254 +118,231 @@ 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
|
||||||
DEVELOPMENT BRANCHES: inxi-perl, one, two
|
DEVELOPMENT BRANCHES: inxi-perl, one, two
|
||||||
inxi-perl is the dev branch, the others are rarely if ever used. inxi
|
inxi-perl is the dev branch, the others are rarely if ever used. inxi itself
|
||||||
itself has the built in feature to be able to update itself from
|
has the built in feature to be able to update itself from anywhere, including
|
||||||
anywhere, including these branches, which is very useful for development
|
these branches, which is very useful for development and debugging on various
|
||||||
and debugging on various user systems.
|
user systems.
|
||||||
|
|
||||||
PULL REQUESTS: Please talk to me before starting to work on patches of
|
PULL REQUESTS: Please talk to me before starting to work on patches of any
|
||||||
any reasonable complexity. inxi is hard to work on, and you have to
|
reasonable complexity. inxi is hard to work on, and you have to understand how
|
||||||
understand how it works before submitting patches, unless it's a trivial
|
it works before submitting patches, unless it's a trivial bug fix. Please:
|
||||||
bug fix. Please: NEVER even think about looking at or using previous
|
NEVER even think about looking at or using previous inxi commits, previous to
|
||||||
inxi commits, previous to the current master version, as a base for a
|
the current master version, as a base for a patch. If you do, your patch / pull
|
||||||
patch. If you do, your patch / pull request will probably be rejected.
|
request will probably be rejected. Developers, get your version from the
|
||||||
Developers, get your version from the inxi-perl branch, pinxi, otherwise
|
inxi-perl branch, pinxi, otherwise you may not be current to actual development
|
||||||
you may not be current to actual development versions. inxi-perl pinxi
|
versions. inxi-perl pinxi is always equal to or ahead of master branch inxi.
|
||||||
is always equal to or ahead of master branch inxi.
|
|
||||||
|
|
||||||
Man page updates, doc page updates, etc, of course, are easy and will
|
Man page updates, doc page updates, etc, of course, are easy and will probably
|
||||||
probably be accepted, as long as they are properly formatted and
|
be accepted, as long as they are properly formatted and logically coherent.
|
||||||
logically coherent.
|
|
||||||
|
|
||||||
inxi releases early, and releases often, when under development.
|
When under active development, inxi releases early, and releases often.
|
||||||
|
|
||||||
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/version in the master branch (plus pinxi inxi-perl branch, of course,
|
||||||
those should never be packaged).
|
but those should never be packaged).
|
||||||
|
|
||||||
=====================================================================
|
===============================================================================
|
||||||
ABOUT INXI - CORE COMMITMENT TO LONG TERM STABILITY
|
ABOUT INXI - CORE COMMITMENT TO LONG TERM STABILITY
|
||||||
|
|
||||||
inxi is a command line system information tool. It was forked from the
|
inxi is a command line system information tool. It was forked from the ancient
|
||||||
ancient and mindbendingly perverse yet ingenius infobash, by locsmif.
|
and mindbendingly perverse yet ingenius infobash, by locsmif.
|
||||||
|
|
||||||
That was a buggy, impossible to update or maintain piece of software,
|
That was a buggy, impossible to update or maintain piece of software, so the
|
||||||
so the fork fixed those core issues, and made it flexible enough to
|
fork fixed those core issues, and made it flexible enough to expand the utility
|
||||||
expand the utility of the original ideas. Locmsif has given his thumbs
|
of the original ideas. Locmsif has given his thumbs up to inxi, so don't be
|
||||||
up to inxi, so don't be fooled by legacy infobash stuff you may see
|
fooled by legacy infobash stuff you may see out there.
|
||||||
out there.
|
|
||||||
|
|
||||||
inxi is lower case, except when I create a text header here in a file
|
inxi is lower case, except when I create a text header here in a file like
|
||||||
like this, but it's always lower case. Sometimes to follow convention
|
this, but it's always lower case. Sometimes to follow convention I will use
|
||||||
I will use upper case inxi to start a sentence, but i find it a bad
|
upper case inxi to start a sentence, but i find it a bad idea since invariably,
|
||||||
idea since invariably, someone will repeat that and type it in as the
|
someone will repeat that and type it in as the command name, then someone will
|
||||||
command name, then someone will copy that, and complain that the
|
copy that, and complain that the command: Inxi doesn't exist...
|
||||||
command: Inxi doesn't exist...
|
|
||||||
|
|
||||||
The primary purpose of inxi is for support, and sys admin use. inxi
|
The primary purpose of inxi is for support, and sys admin use. inxi is used
|
||||||
is used widely for forum and IRC support, which is I believe it's most
|
widely for forum and IRC support, which is I believe it's most common function.
|
||||||
common function.
|
|
||||||
|
|
||||||
If you are piping output to paste or post (or writing to file), inxi
|
If you are piping output to paste or post (or writing to file), inxi now
|
||||||
now automatically turns off color codes, so the old suggestion to
|
automatically turns off color codes, so the old suggestion to use -c 0 to turn
|
||||||
use -c 0 to turn off colors is no longer required.
|
off colors is no longer required.
|
||||||
|
|
||||||
inxi should always show you your current system state, as far as
|
inxi should always show you your current system state, as far as possible, and
|
||||||
possible, and should be more reliable than your own beliefs about
|
should be more reliable than your own beliefs about what is in your system,
|
||||||
what is in your system, ideally. In other words, the goal in inxi
|
ideally. In other words, the goal in inxi is to have it be right more than it
|
||||||
is to have it be right more than it is wrong about any system that
|
is wrong about any system that it runs on. And not to rely on non current
|
||||||
it runs on. And not to rely on non current system state data if at
|
system state data if at all possible. Some things, like memory/ram data, rely
|
||||||
all possible. Some things, like memory/ram data, rely on radically
|
on radically unreliable system self reporting based on OEM filling out data
|
||||||
unreliable system self reporting based on OEM filling out data
|
correctly, which doesn't often happen, so in those cases, you want to confirm
|
||||||
correctly, which doesn't often happen, so in those cases, you want to
|
things like ram capacity with a reputable hardware source, like crucial.com,
|
||||||
confirm things like ram capacity with a reputable hardware source,
|
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,
|
||||||
time. Well, all systems with the core tools inxi requires to operate
|
all systems with the core tools inxi requires to operate installed. Ie, not
|
||||||
installed. Ie, not Android, yet. What this means is this: you can
|
Android, yet. What this means is this: you can have a 10 year old box, or
|
||||||
have a 10 year old box, or probably 15, not sure, and you can install
|
probably 15, not sure, and you can install today's inxi on it, and it will run.
|
||||||
today's inxi on it, and it will run. It won't run fast, but it will
|
It won't run fast, but it will run. I test inxi on a 200 MHz laptop from about
|
||||||
run. I test inxi on a 200 MHz laptop from about 1998 to keep it
|
1998 to keep it honest. That's also what was used to optimize the code at some
|
||||||
honest. That's also what was used to optimize the code at some
|
points, since differences appear as seconds, not 10ths or 100ths of seconds on
|
||||||
points, since differences appear as seconds, not 10ths or 100ths
|
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 work on any
|
||||||
work on any system that runs Perl 5.08 or later. Pre 2.9.0 Gawk/Bash
|
system that runs Perl 5.08 or later. Pre 2.9.0 Gawk/Bash inxi will also run on
|
||||||
inxi will also run on any system no matter how old, within reason,
|
any system no matter how old, within reason, so there should be no difference.
|
||||||
so there should be no difference.
|
|
||||||
|
|
||||||
=====================================================================
|
===============================================================================
|
||||||
BSD SUPPORT
|
BSD SUPPORT
|
||||||
|
|
||||||
Real BSDs:
|
Real BSDs:
|
||||||
BSD support is not as complete as GNU/Linux support due to the fact
|
BSD support is not as complete as GNU/Linux support due to the fact some of the
|
||||||
some of the data simply is not available, or is structured in a way
|
data simply is not available, or is structured in a way that makes it unique to
|
||||||
that makes it unique to each BSD. This fragmentation makes supporting
|
each BSD. This fragmentation makes supporting BSDs far more difficult than it
|
||||||
BSDs far more difficult than it should be in the 21st century. The
|
should be in the 21st century. The BSD support in inxi is an ongoing process,
|
||||||
BSD support in inxi is an ongoing process, with more features being
|
with more features being added as new data sources and types are discovered.
|
||||||
added as new data sources and types are discovered.
|
|
||||||
|
|
||||||
All BSD issue reports unless trivial and obvious will require 1 of
|
All BSD issue reports unless trivial and obvious will require 1 of two things:
|
||||||
two things:
|
|
||||||
|
|
||||||
1. a full --debug 21 data dump so I don't have to spend days trying
|
1. a full --debug 21 data dump so I don't have to spend days trying to get the
|
||||||
to get the information I need to resolve the issue file by painful
|
information I need to resolve the issue file by painful file from the issue
|
||||||
file from the issue poster. This is only the start of the process,
|
poster. This is only the start of the process, and realistically requires 2. to
|
||||||
and realistically requires 2. to complete it.
|
complete it.
|
||||||
|
|
||||||
2. direct SSH access to at least a comparable live BSD version/system,
|
2. direct SSH access to at least a comparable live BSD version/system, that is,
|
||||||
that is, if the issue is on a laptop, access has to be granted to the
|
if the issue is on a laptop, access has to be granted to the laptop, or a
|
||||||
laptop, or a similar one.
|
similar one.
|
||||||
|
|
||||||
Option 2 is far preferred because in terms of my finite time on this
|
Option 2 is far preferred because in terms of my finite time on this planet of
|
||||||
planet of ours, the fact is, if I don't have direct (or SSH) access,
|
ours, the fact is, if I don't have direct (or SSH) access, I can't get much
|
||||||
I can't get much done, and the little I can get done will take 10 to
|
done, and the little I can get done will take 10 to 1000x longer than it
|
||||||
1000x longer than it should. That's my time spent (and sadly, with
|
should. That's my time spent (and sadly, with BSDs, largely lost), not yours.
|
||||||
BSDs, largely lost), not yours.
|
|
||||||
|
|
||||||
I decided I have to adopt this much more strict policy with BSDs
|
I decided I have to adopt this much more strict policy with BSDs after wasting
|
||||||
after wasting untold hours on trying to get good BSD support, only
|
untold hours on trying to get good BSD support, only to see that support break
|
||||||
to see that support break a few years down the road as the data inxi
|
a few years down the road as the data inxi relied in changed structure or
|
||||||
relied in changed structure or syntax, or the tools changed, or
|
syntax, or the tools changed, or whatever else makes the BSDs such a challenge
|
||||||
whatever else makes the BSDs such a challenge to support. In the end,
|
to support. In the end, I realized, the only BSDs that are well supported are
|
||||||
I realized, the only BSDs that are well supported are ones that I have
|
ones that I have had direct access to for debugging and testing.
|
||||||
had direct access to for debugging and testing.
|
|
||||||
|
|
||||||
I will always accept patches that are well done, if they do not break
|
I will always accept patches that are well done, if they do not break
|
||||||
GNU/Linux, and extend BSD support, or add new BSD features, and follow
|
GNU/Linux, and extend BSD support, or add new BSD features, and follow the
|
||||||
the internal inxi logic, and aren't too long. inxi sets initial internal
|
internal inxi logic, and aren't too long. inxi sets initial internal flags to
|
||||||
flags to identify that it is a BSD system vs a GNU/Linux system, and
|
identify that it is a BSD system vs a GNU/Linux system, and preloads some data
|
||||||
preloads some data structures for BSD use, so make sure you understand
|
structures for BSD use, so make sure you understand what inxi is doing before
|
||||||
what inxi is doing before you get into it.
|
you get into it.
|
||||||
|
|
||||||
OSX:
|
OSX:
|
||||||
Do not insult real BSDs by calling OSX a BSD. OSX is the least
|
Do not insult real BSDs by calling OSX a BSD. OSX is the least Unix-like
|
||||||
Unix-like operating system I've ever seen that claims to be a Unix,
|
operating system I've ever seen that claims to be a Unix, its tools are
|
||||||
its tools are mutated, it's data randomly and non-standardly organized,
|
mutated, it's data randomly and non-standardly organized, and it totally fails
|
||||||
and it totally fails to respect the 'spirit' of Unix, even though it
|
to respect the 'spirit' of Unix, even though it might pass some random tests
|
||||||
might pass some random tests that certify a system as a 'Unix'.
|
that certify a system as a 'Unix'.
|
||||||
|
|
||||||
If you want me to use my time on OSX features or issues, you have to
|
If you want me to use my time on OSX features or issues, you have to pay me,
|
||||||
pay me, because Apple is all about money, not freedom (that's what
|
because Apple is all about money, not freedom (that's what the 'free' in 'free
|
||||||
the 'free' in 'free software' is referring to, not cost), and I'm not
|
software' is referring to, not cost), and I'm not donating my finite time in
|
||||||
donating my finite time in support of non-free operating systems.
|
support of non-free operating systems.
|
||||||
|
|
||||||
=====================================================================
|
===============================================================================
|
||||||
INXI FEATURES AND FUNCTIONALITY
|
INXI FEATURES AND FUNCTIONALITY
|
||||||
|
|
||||||
inxi's functionality continues to grow over time, but it's also
|
inxi's functionality continues to grow over time, but it's also important to
|
||||||
important to understand that each core new feature usually requires
|
understand that each core new feature usually requires about 30 days work to
|
||||||
about 30 days work to get it stable. So new features are not trivial
|
get it stable. So new features are not trivial things, nor is it acceptable to
|
||||||
things, nor is it acceptable to submit a patch that works only on your
|
submit a patch that works only on your personal system. One inxi feature (-s,
|
||||||
personal system. One inxi feature (-s, sensors data), took about
|
sensors data), took about 2 hours to get working in the alpha test on the local
|
||||||
2 hours to get working in the alpha test on the local dev system, but
|
dev system, but then to handle the massive chaos that is actual user sensors
|
||||||
then to handle the massive chaos that is actual user sensors output
|
output and system variations, it took several rewrites and about 30 days to
|
||||||
and system variations, it took several rewrites and about 30 days to
|
get somewhat reliable for about 98% or so of inxi users. So if your patch is
|
||||||
get somewhat reliable for about 98% or so of inxi users. So if your
|
rejected, it's likely because you have not thought it through adequately, have
|
||||||
patch is rejected, it's likely because you have not thought it through
|
not done adequate testing cross system and platform, etc.
|
||||||
adequately, have not done adequate testing cross system and
|
|
||||||
platform, etc.
|
|
||||||
|
|
||||||
=====================================================================
|
===============================================================================
|
||||||
INXI RELEASE/SUPPORT/ISSUES/BUGS INFORMATION:
|
INXI VERSION/SUPPORT/ISSUES/BUGS INFORMATION:
|
||||||
|
|
||||||
Important: the only version of inxi that is supported is the latest
|
Important: the only version of inxi that is supported is the latest current
|
||||||
current master branch release. No issue reports or bug reports will be
|
master branch version/commit. No issue reports or bug reports will be accepted
|
||||||
accepted for anything other than current master branch. No merges,
|
for anything other than current master branch. No merges, attempts to patch old
|
||||||
attempts to patch old code from old releases, will be considered or
|
code from old versions, will be considered or accepted. If you are not updated
|
||||||
accepted. If you are not updated to the latest inxi, do not file a
|
to the latest inxi, do not file a bug report since it's probably been fixed
|
||||||
bug report since it's probably been fixed ages ago. If your distro
|
ages ago. If your distro isn't packaging a current inxi, then file a bug report
|
||||||
isn't packaging a current inxi, then file a bug report with them, not
|
with them, not here. The only valid working code base for inxi is the current
|
||||||
here. The only valid working code base for inxi is the current
|
master branch commit of inxi.
|
||||||
release of inxi.
|
|
||||||
|
|
||||||
Distributions should never feel any advantage comes from using old
|
Distributions should never feel any advantage comes from using old inxi
|
||||||
inxi releases because inxi has as a core promise to you, the end user,
|
versions because inxi has as a core promise to you, the end user, that it will
|
||||||
that it will NEVER require new tools to run. New tools may be required
|
never require new tools to run. New tools may be required for a new feature,
|
||||||
for a new feature, but that will always be handled internally by inxi,
|
but that will always be handled internally by inxi, and will not cause any
|
||||||
and will not cause any operational failures. This is a promise, and I
|
operational failures. This is a promise, and I will never as long as I run this
|
||||||
will never as long as I run this project violate that core inxi
|
project violate that core inxi requirement. Old inxi is NOT more stable than
|
||||||
requirement. Old inxi is NOT more stable than current inxi, it's just
|
current inxi, it's just old, and lacking in bug fixes and features. For pre 2.9
|
||||||
old, and lacking in bug fixes and features. For pre 2.9 releases, it's
|
versions, it's also significantly slower, and with fewer features.
|
||||||
also significantly slower, and with fewer features.
|
|
||||||
|
|
||||||
inxi is a rolling release codebase, just like Debian Sid, Gentoo, or
|
inxi is 'rolling release' software, just like Debian Sid, Gentoo, or Arch Linux
|
||||||
Arch Linux are rolling release GNU/Linux distributions, with no
|
are rolling release GNU/Linux distributions, with no 'release points'.
|
||||||
'release points'.
|
|
||||||
|
|
||||||
Your distro not updating inxi ever, then failing to show something
|
Your distro not updating inxi ever, then failing to show something that is
|
||||||
that is fixed in current inxi is not a bug, and please do not post it
|
fixed in current inxi is not a bug, and please do not post it here. File the
|
||||||
here. File the issue with your distro, not here. Updating inxi in a
|
issue with your distro, not here. Updating inxi in a package pool will NEVER
|
||||||
package pool will NEVER make anything break or fail, period. It has no
|
make anything break or fail, period. It has no version based dependencies, just
|
||||||
version based dependencies, just software, like Perl 5.xx, lspci, etc.
|
software, like Perl 5.xx, lspci, etc. There is never a valid reason to not
|
||||||
There is never a valid reason to not update inxi in a package pool of
|
update inxi in a package pool of any distro in the world (with one single known
|
||||||
any distro in the world (with one single known exception, the Slackware
|
exception, the Slackware based Puppy Linux release, which ships without the
|
||||||
based Puppy Linux release, which ships without the full Perl language.
|
full Perl language. The Debian based one works fine).
|
||||||
The Debian based one works fine).
|
|
||||||
|
|
||||||
Sys Admin type inxi users always get the first level of support. ie,
|
Sys Admin type inxi users always get the first level of support. ie, convince
|
||||||
convince us you run real systems and networks, and your issue shoots
|
us you run real systems and networks, and your issue shoots to the top of the
|
||||||
to the top of the line. As do any real bugs. Failure to supply
|
line. As do any real bugs. Failure to supply requested debugger data will lead
|
||||||
requested debugger data will lead to a distinct lack of interest on
|
to a distinct lack of interest on our part to help you with a bug. ie, saying,
|
||||||
our part to help you with a bug. ie, saying, oh, x doesn't work,
|
oh, it doesn't work, doesn't cut it, unless it's obvious why.
|
||||||
doesn't cut it, unless it's obvious why.
|
|
||||||
|
|
||||||
=====================================================================
|
===============================================================================
|
||||||
|
|
||||||
INXI VERSION NUMBERING:
|
INXI VERSION NUMBERING:
|
||||||
|
|
||||||
inxi uses 'semantic' version numbering, where the version numbers
|
inxi uses 'semantic' version numbering, where the version numbers actually mean
|
||||||
actually mean something.
|
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.
|
The first digit(s), "3", is a major version, and almost never changes. Only a
|
||||||
Only a huge milestone, or if inxi reaches 3.9.xx, when it will simply
|
huge milestone, or if inxi reaches 3.9.xx, when it will simply move up to 4.0.0
|
||||||
move up to 4.0.0 just to keep it clean, would cause a change.
|
just to keep it clean, would cause a change.
|
||||||
|
|
||||||
The second digit(s), "2", means a new real feature has been added.
|
The second digit(s), "2", means a new real feature has been added. Not a
|
||||||
Not a tweaked existing feature, an actual new feature, which usually
|
tweaked existing feature, an actual new feature, which usually also has a new
|
||||||
also has a new argument option letter attached. The second number goes
|
argument option letter attached. The second number goes from 0 to 9, and then
|
||||||
from 0 to 9, and then rolls over the first after 9. It could also be
|
rolls over the first after 9. It could also be adding a very complicated
|
||||||
adding a very complicated expansion of existing features, like Wayland.
|
expansion of existing features, like Wayland. It depends.
|
||||||
It depends.
|
|
||||||
|
|
||||||
The third, "28", is for everything small, can cover bug fixes, tweaks
|
The third, "28", is for everything small, can cover bug fixes, tweaks to
|
||||||
to existing features to add support for something, pretty much anything
|
existing features to add support for something, pretty much anything where you
|
||||||
where you want the end user to know that they are not up to date. The
|
want the end user to know that they are not up to date. The third goes from 0
|
||||||
third goes from 0 to 99, then rolls over the second.
|
to 99, then rolls over the second.
|
||||||
|
|
||||||
The fourth, "6", is extra information about certain types of inxi
|
The fourth, "6", is extra information about certain types of inxi updates. I
|
||||||
updates. I don't usually use this last one in master branch, but you
|
don't usually use this last one in master branch, but you will see it in
|
||||||
will see it in branches one,two, inxi-perl, inxi-legacy since that is
|
branches one,two, inxi-perl, inxi-legacy since that is used to confirm remote
|
||||||
used to confirm remote test system patch version updates.
|
test system patch version updates.
|
||||||
|
|
||||||
The fourth number, when used, will be alpha-numeric, a common version
|
The fourth number, when used, will be alpha-numeric, a common version would be,
|
||||||
would be, in say, branch one: 2.2.28-b1-02, in other words, a branch 1
|
in say, branch one: 2.2.28-b1-02, in other words: branch 1 patch version 2.
|
||||||
release, version 2.
|
|
||||||
|
|
||||||
In the past, now and then the 4th, or 'patch', number, was used in
|
In the past, now and then the 4th, or 'patch', number, was used in trunk/master
|
||||||
trunk/master branches of inxi, but I've pretty much stopped doing that
|
branches of inxi, but I've pretty much stopped doing that because it's
|
||||||
because it's confusing.
|
confusing.
|
||||||
|
|
||||||
inxi does not use the fiction of date based versioning because that
|
inxi does not use the fiction of date based versioning because that imparts no
|
||||||
imparts no useful information to the end user, when you look at say,
|
useful information to the end user, when you look at say, 2.2.28, and you last
|
||||||
2.2.28, and you last had 2.2.11, you can know with some certainty that
|
had 2.2.11, you can know with some certainty that inxi has no major new
|
||||||
inxi has no major new features, just fine tunings and bug fixes. And
|
features, just fine tunings and bug fixes. And if you see one with 2.3.2, you
|
||||||
if you see one with 2.3.2, you will know that there is a new feature,
|
will know that there is a new feature, almost, but not always, linked to one or
|
||||||
almost, but not always, linked to one or more new line output items.
|
more new line output items. Sometimes a fine tuning can be quite significant,
|
||||||
Sometimes a fine tuning can be quite significant, sometimes it's a
|
sometimes it's a one line code fix.
|
||||||
one line code fix.
|
|
||||||
|
|
||||||
A move to a new full version number, like the rewrite of inxi to Perl,
|
A move to a new full version number, like the rewrite of inxi to Perl, would
|
||||||
would reflect in first version say, 2.9.01, then after a period of
|
reflect in first version say, 2.9.01, then after a period of testing, where
|
||||||
testing, where most little glitches are fixed, a move to 3.0.0. These
|
most little glitches are fixed, a move to 3.0.0. These almost never happen. I
|
||||||
almost never happen. I do not expect for example version 4.0 to ever
|
do not expect for example version 4.0 to ever happen after 3.0 (early 2018),
|
||||||
happen after the 3.0 release of early 2018, unless so many new
|
unless so many new features are added that it actually hits 3.9, then it would
|
||||||
features are added that it actually hits 3.9, then it would roll
|
roll over to 4.
|
||||||
over to 4.
|
|
||||||
|
|
||||||
### EOF ###
|
### EOF ###
|
||||||
|
|
Loading…
Reference in a new issue