mirror of
https://github.com/smxi/inxi.git
synced 2024-11-16 08:11:39 +00:00
armbsdcli-utilitieslinuxperlperl5remote-admin-toolsupport-toolssysadmin-toolsysinfosystem-administration
f571b45973
Most of these were exposed by issue #251 filed by LukasNickel, then further revealed via his debugger data set, which showed two more bugs. Well, bugs, changed syntaxes, same difference to end users. -------------------------------------------------------------------------------- KNOWN ISSUES: 1. Work is ongoing to add btrfs support to -R (similar to softraid or zfs), basic stubs and debuggers added, but reporting tools are not as robust (and often require sudo/root for reasons that escape me) as I would have hoped, so it's slow. One of these days... Normally would not release with working stubs, but there were enough real issues/bugs to warrant just getting 3.3.06 out the door, then going on with the btrfs feature for -R. But so far I view the reporting tools as inadequate, unfortunately. -------------------------------------------------------------------------------- BUGS: 1. As initially discovered in issue #251 there are alternate syntaxes which had never been seen before for remote mounts, fuse mounts, etc. In this case, it was fuse.sshfs that was not removed from the Disk total:... used: leading to silly 1000+% used percentage. Note that while technically inxi could try to be clever about reporting impossible percentages, so far those have led to bugs getting reported, then fixed, so I think it worth leaving it as is. 2. When --swap/-j is used with no other arguments, failed to show uuid or label. Discovered this while testing fix 2. 3. Bug which is not a bug but will appear as such to users, nvme temps were failing in -Dx due to a change in how those values are located in /sys. See fix 3. -------------------------------------------------------------------------------- FIXES: 1. Going along with Bug 1, and considering that only in 3.3.05 was the nfs4 remote fs failure to identify/exclude, the entire section involving remote/ fuse etc file systems was refactored, and extended to add many more previously non-handled remote and fuse type file systems. Significant extension of known remote filesystem types, distributed file systems, overlay file systems, all to try to avoid having more distributed/remote/fuse file system issues. Also added test to support fuse. or fuseblk. type prefixes for any of these. Hopefully there will be fewer issues related to distributed and remote and overlay type file systems in the future. 2. Made all label/uuid triggers global, that is, -ol shows unmounted with labels, -ju shows swap with uuid, and so on. This may require a bit more tweaks to get exactly right, but in general, this is a purely cosmetic fix, that is, try not to show label/uuid for partition/mounts that probably can't have those values. 3. There was a change in the way nvme /sys temperature paths were handled, an actually understandable, albeit as always annoying, one, because inxi actually had to do a sort of convoluted hack to get the nvme block devices temperatore paths before, now that hack is not required for newer kernels (5.12+), though for kernels that had the old paths (5,8, 5.9 at least, don't know when paths changed) left in the old method. Now tests are more granular, and inxi should find temperatures regardless of which method is used for nvme and sd type drives. 4. Another somewhat irksome random change, again, understandable since the new syntax is more consistent in output than the previous one, but still breaks all existing parsers that use the changed field names. Lsblk did NOT change the -o input field names, but DID change the output field names, which broke the internal inxi parser, and led to null lsblk data. Changes were - or : separators in input values are output as _ always. that is, MAJ:MIN becomes MAJ_MIN. Also corrected the debugger lsblk to use the same output fields for -P -o as the actual lsblk parser uses internally so these failures can be spotted more readily, as it was, it was literally only because someone submitted the debugger dataset, and was running lsblk 2.37, where I believe this behavior change happened. Solution was to just use regex patterns instead, [:_-], in the parser. Big fear now is that they will randomly stop supporting the -o input field names that contain - or : and change that too without any real warning or deprecation notice. -------------------------------------------------------------------------------- ENHANCEMENTS: 1. Going with bug and fix 1, added avfs, afs, archivemount, avfs, ceph, gfs, glusterfs, gmailfs, hdfs, ipfs, kosmos/kfs, lafs, mergerfs, mhddfs, moosefs, ocfs, openafs, orangefs, overlayfs, pvfs, s3fs, sheepdog, vmfs, and several others to the exclude list for disk used and show label/uuids for partitions. 2. A smattering of disk vendors added. -------------------------------------------------------------------------------- CHANGES: 1. Going with fix 2, -l and -u no longer will trigger -P by default, now if -l or -u are used without -j, -o, -p, -P, an error will explain that you must use one of those together with -l or -u. This was the only way to get the -l and -u switches to turn off/on label/uuid reports in swap, unmounted, and partitions consistently. Triggering -P was really a legacy behavior from when the only options were -p or -P, and --swap and --unmounted did not exist. I found it increasingly odd that unmounted would show label/uuid always but partitions only with -l/-u. 2. This was a pet peeve, sometimes field names just bug me (like 'Topology: did for CPU, now corrected to Info:), the Drive: rotation: was one such annoyance. I had recycled that to indicate SSD, which was a feature request, but that was always a sloppy solution, and made no sense, since SSD isn't a rotation speed. Now it reports a much more logical: ID-1:...... type: HDD rpm: 7200 or ID-1:...... type: SSD or ID-1:...... type: N/A This also corresponds to the intended meaning much better. The HDD type was always present internally if rotation speed is detected, but was not used. Now will also show type: N/A if reliable type detection failed, which will also be more consistent. -------------------------------------------------------------------------------- DOCUMENTATION: 1. Brought most of inxi.changelog (this file) into a consistent state, re whitespaces, readability, consistent use of various header / section names. Ideally while I don't expect anyone to ever sit down and read this changelog, it will be now much easier to scan to find whatever interests you. This change goes along with ongoing changes in docs to in general try to be usually 80 columns wide. 2. inxi-resources.txt, inxi-data.txt are updated with more raid, partition, file system values and data to go along with bug, fix, enhancement 1. 3. Man and help updated to indicate -u and -l no longer trigger -P by default. -------------------------------------------------------------------------------- CODE: 1. Ongoing refactors, bringing the codebase to the point that matches current coding styles. Removed remainder of whitespaces in conditions and for/while loops, for example: if ( condition ) { becomes: if (condition){ and if ( ( test set 1 ) && ( test set 2 ) ) { becomes: if ((test set 1) && (test set 2)){ and so on. That dropped over 2 KiB of whitespaces. This went along with fixes that have been ongoing to change to this whitespace use style, but previously it was only being done when that situation was hit in a local block, now it's been completed globally. This continues the style refactor that has been ongoing for a while now, to bring inxi into a consistent state, since when it started, it was more pressing to get the bash/gawk mess translated to Perl than it was to get the Perl itself to be as good/consistent as possible, so now those issues are being slowly unravelled, and hopefully will set inxi on course for its next 10 years. It was starting to get annoying, because some parts of inxi used those spaces, and all newer ones didn't in general. Now it's one behavior throughout the whole program file. 2. Refactored the entire fs exclude for disk used data, and integrated those values into a global tool that is used either to exclude file systems from disk used totals, or to not show uuid/labels for the excluded remote/distributed/overlay type file systems, which in general don't have uuid or labels. |
||
|---|---|---|
| inxi | ||
| inxi.1 | ||
| inxi.changelog | ||
| LICENSE.txt | ||
| README.txt | ||
README for inxi - a command line system information tool The new faster, more powerful Perl inxi is here! File all issue reports with the master branch. 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 filing any issue reports. The code in pre 2.9 versions literally no longer exists in inxi 3. Bugs from earlier versions cannot usually be solved in the new version since the pre 2.9 and the 2.9 and later versions are completely different internally. ================================================================================ DEVELOPMENT AND ISSUES -------------------------------------------------------------------------------- Make inxi better! Expand supported hardware and OS data, fix broken items! -------------------------------------------------------------------------------- HELP PROJECT DEVELOPMENT! SUBMIT A DEBUGGER DATASET -------------------------------------------------------------------------------- This is easy to do, and only takes a few seconds. These datasets really help the project add and debug features. You will generally also be asked to provide this data for non trivial issue reports. Note that the following options are present: 1. Generate local gz'ed debugger dataset. Leaves gz on your system: inxi version 3: inxi --debug 20 inxi version <= 2.3: inxi -@14 2. Generate, upload gz'ed debugger dataset. Leaves gz on your system: inxi version 3: inxi --debug 21 inxi version <= 2.3: inxi -xx@14 3. Generate, upload, delete gz'ed debugger dataset: inxi version 3 only: inxi --debug 22 You can run these as regular user, or root/sudo, which will gather a bit more data, like from dmidecode, and other tools that need superuser permissions to run. ARM (plus MIPS, SPARC, PowerPC) and BSD datasets are particularly appreciated because we simply do not have enough of those. -------------------------------------------------------------------------------- FILE AN ISSUE IF YOU FIND SOMETHING MISSING, BROKEN, OR FOR AN ENHANCEMENT -------------------------------------------------------------------------------- inxi strives to support the widest range of operating systems and hardware, from the most simple consumer desktops, to the most advanced professional hardware and servers. The issues you post help maintain or expand that support, and are always appreciated since user data and feedback is what keeps inxi working and supporting the latest (or not so latest) hardware and operating systems. See INXI VERSION/SUPPORT/ISSUES/BUGS INFORMATION for more about issues/support. See BSD/UNIX below for qualifications re BSDs, and OSX in particular. ================================================================================ SOURCE VERSION CONTROL -------------------------------------------------------------------------------- https://github.com/smxi/inxi MAIN BRANCH: master DEVELOPMENT BRANCHES: inxi-perl, one, two inxi-perl is the dev branch, the others are rarely if ever used. inxi itself has the built in feature to be able to update itself from anywhere, including these branches, which is very useful for development and debugging on various user systems. PULL REQUESTS: Please talk to me before starting to work on patches of any reasonable complexity. inxi is hard to work on, and you have to understand how it works before submitting patches, unless it's a trivial bug fix. Please: NEVER even think about looking at or using previous inxi commits, previous to the current master version, as a base for a patch. If you do, your patch / pull request will probably be rejected. Developers, get your version from the inxi-perl branch, pinxi, otherwise you may not be current to actual development versions. inxi-perl pinxi is always equal to or ahead of master branch inxi. Man page updates, doc page updates, etc, of course, are easy and will probably be accepted, as long as they are properly formatted and logically coherent. When under active development, inxi releases early, and releases often. PACKAGERS: inxi has one and only one 'release', and that is the current commit/version in the master branch (plus pinxi inxi-perl branch, of course, but those should never be packaged). -------------------------------------------------------------------------------- MASTER BRANCH -------------------------------------------------------------------------------- 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 current commit/version in master. All past versions are not supported. git clone https://github.com/smxi/inxi --branch master --single-branch OR direct fast and easy install: wget -O inxi https://github.com/smxi/inxi/raw/master/inxi OR easy to remember shortcut (which redirects to github): wget -O inxi https://smxi.org/inxi wget -O inxi smxi.org/inxi NOTE: Just because github calls tagged commits 'Releases' does not mean they are releases! I can't change the words on the tag page. They are tagged commmits, period. A tag is a pointer to a commit, and has no further meaning. If your distribution has blocked -U self updater and you want a newer version: Open /etc/inxi.conf and change false to true: B_ALLOW_UPDATE=true -------------------------------------------------------------------------------- DEVELOPMENT BRANCH -------------------------------------------------------------------------------- All active development is now done on the inxi-perl branch (pinxi): git clone https://github.com/smxi/inxi --branch inxi-perl --single-branch OR direct fast and easy install: wget -O pinxi https://github.com/smxi/inxi/raw/inxi-perl/pinxi OR easy to remember shortcut (which redirects to github): wget -O pinxi https://smxi.org/pinxi wget -O pinxi smxi.org/pinxi Once new features have been debugged, tested, and are reasonably stable, pinxi is copied to inxi in the master branch. It's a good idea to check with pinxi if you want to make sure your issue has not been corrected, since pinxi is always equal to or ahead of inxi. -------------------------------------------------------------------------------- LEGACY BRANCH -------------------------------------------------------------------------------- If you'd like to look at or check out the Gawk/Bash version of inxi, you can find it here, at the inxi-legacy branch (binxi): git clone https://github.com/smxi/inxi --branch inxi-legacy --single-branch OR direct fast and easy install: wget -O binxi https://github.com/smxi/inxi/raw/inxi-legacy/binxi OR easy to remember shortcut (which redirects to github): wget -O binxi https://smxi.org/binxi This version will not be maintained, and it's unlikely that any time will be spent on it in the future, but it is there in case it's of use or interest to anyone. ================================================================================ SUPPORT INFO -------------------------------------------------------------------------------- Do not ask for basic help that reading the inxi -h / --help menus, or 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 update its inxi version, some are bad about that. -------------------------------------------------------------------------------- DOCUMENTATION -------------------------------------------------------------------------------- https://smxi.org/docs/inxi.htm (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 resources. https://github.com/smxi/inxi/tree/inxi-perl/docs Contains specific Perl inxi documentation, of interest mostly to developers. Includes internal inxi tools, values, configuration items. Also has useful information about Perl version support, including the list of Core modules that _should_ be included in a distribution's core modules, but which are unfortunately sometimes removed. INXI CONFIGURATION: https://smxi.org/docs/inxi-configuration.htm HTML MAN PAGE: https://smxi.org/docs/inxi-man.htm INXI OPTIONS PAGE: http://smxi.org/docs/inxi-options.htm NOTE: Check the inxi version number on each doc page to see which version will support the options listed. The man and options page also link to a legacy version, pre 2.9. -------------------------------------------------------------------------------- IRC -------------------------------------------------------------------------------- You can go to: irc.oftc.net channel #smxi but be prepared to wait around for a while to get a response. Generally it's better to use github issues. -------------------------------------------------------------------------------- ISSUES -------------------------------------------------------------------------------- https://github.com/smxi/inxi/issues No issues accepted for non current inxi versions. See below for more on that. Unfortunately as of 2.9, no support or issues can be accepted for older inxi's because inxi 2.9 (Perl) and newer is a full rewrite, and 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 to work with Gawk->Bash again!). Sys Admin type inxi users always get the first level of support. ie, convince us you run real systems and networks, and your issue shoots to the top of the line. As do any real bugs. Failure to supply requested debugger data will lead To a distinct lack of interest on our part to help you with a bug. ie, saying, oh, it doesn't work, doesn't cut it, unless it's obvious why. -------------------------------------------------------------------------------- SUPPORT FORUMS -------------------------------------------------------------------------------- https://techpatterns.com/forums/forum-33.html This is the best place to place support issues that may be complicated. If you are developer, use: DEVELOPER FORUMS: https://techpatterns.com/forums/forum-32.html ================================================================================ ABOUT INXI -------------------------------------------------------------------------------- inxi is a command line system information tool. It was forked from the ancient and mindbendingly perverse yet ingenius infobash, by locsmif. That was a buggy, impossible to update or maintain piece of software, so the fork fixed those core issues, and made it flexible enough to expand the utility of the original ideas. Locmsif has given his thumbs up to inxi, so don't be fooled by legacy infobash stuff you may see out there. inxi is lower case, except when I create a text header here in a file like this, but it's always lower case. Sometimes to follow convention I will use upper case inxi to start a sentence, but i find it a bad idea since invariably, someone will repeat that and type it in as the command name, then someone will copy that, and complain that the command: Inxi doesn't exist... The primary purpose of inxi is for support, and sys admin use. inxi is used widely for forum and IRC support, which is I believe it's most common function. If you are piping output to paste or post (or writing to file), inxi now automatically turns off color codes, so the old suggestion to use -c 0 to turn off colors is no longer required. inxi strives to be as accurate as possible, but some things, like memory/ram data, depend on radically unreliable system self reporting based on OEM filling out data correctly, which doesn't often happen, so in those cases, you want to confirm things like ram capacity with a reputable hardware source, like crucial.com, which has the best ram hardware tool I know of. -------------------------------------------------------------------------------- COMMITMENT TO LONG TERM STABILITY -------------------------------------------------------------------------------- The core mission of inxi is to always work on all systems all the time. Well, all systems with the core tools inxi requires to operate installed. What this means is this: you can have a 10 year old box, or probably 15, not sure, and you can install today's inxi on it, and it will run. It won't run fast, but it will run. I test inxi on a 200 MHz laptop from about 1998 to keep it 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 old systems like that. inxi is being written, and tested, on Perl as old as 5.08, and will work on any system that runs Perl 5.08 or later. Pre 2.9.0 Gawk/Bash inxi will also run on any system no matter how old, within reason, so there should be no difference. -------------------------------------------------------------------------------- FEATURES AND FUNCTIONALITY -------------------------------------------------------------------------------- inxi's functionality continues to grow over time, but it's also important to understand that each core new feature usually requires about 30 days work to get it stable. So new features are not trivial things, nor is it acceptable to submit a patch that works only on your personal system. One inxi feature (-s, sensors data), took about 2 hours to get working in the alpha test on the local dev system, but then to handle the massive chaos that is actual user sensors output 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 rejected, it's likely because you have not thought it through adequately, have not done adequate testing cross system and platform, etc. -------------------------------------------------------------------------------- SUPPORTED VERSIONS / DISTRO VERSIONS -------------------------------------------------------------------------------- Important: the only version of inxi that is supported is the latest current master branch version/commit. No issue reports or bug reports will be accepted for anything other than current master branch. No merges, attempts to patch old code from old versions, will be considered or accepted. If you are not updated to the latest inxi, do not file a bug report since it's probably been fixed ages ago. If your distro isn't packaging a current inxi, then file a bug report with your packager, not here. inxi is 'rolling release' software, just like Debian Sid, Gentoo, or Arch Linux are rolling release GNU/Linux distributions, with no 'release points'. Distributions should never feel any advantage comes from using old inxi versions because inxi has as a core promise to you, the end user, that it will never require new tools to run. New tools may be required for a new feature, but that will always be handled internally by inxi, and will not cause any operational failures. This is a promise, and I will never as long as I run this project violate that core inxi requirement. Old inxi is NOT more stable than current inxi, it's just old, and lacking in bug fixes and features. For pre 2.9 versions, it's also significantly slower, and with fewer features. Your distro not updating inxi ever, then failing to show something that is fixed in current inxi is not a bug, and please do not post it here. File the issue with your distro, not here. Updating inxi in a package pool will NEVER make anything break or fail, period. It has no version based dependencies, just software, like Perl 5.xx, lspci, etc. There is never a valid reason to not update inxi in a package pool of any distro in the world (with one single known exception, the Slackware based Puppy Linux release, which ships without the full Perl language. The Debian based one works fine). -------------------------------------------------------------------------------- SEMANTIC VERSION NUMBERING -------------------------------------------------------------------------------- inxi uses 'semantic' version numbering, where the version numbers actually mean something. The version number follows these guidelines: Using example 3.2.28-6 The first digit(s), "3", is a major version, and almost never changes. Only a huge milestone, or if inxi reaches 3.9.xx, when it will simply 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 tweaked existing feature, an actual new feature, which usually also has a new argument option letter attached. The second number goes from 0 to 9, and then rolls over the first after 9. It could also be 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 existing features to add support for something, pretty much anything where you want the end user to know that they are not up to date. The third goes from 0 to 99, then rolls over the second. The fourth, "6", is extra information about certain types of inxi updates. I don't usually use this last one in master branch, but you will see it in branches one,two, inxi-perl, inxi-legacy since that is used to confirm remote test system patch version updates. The fourth number, when used, will be alpha-numeric, a common version would be, in say, branch one: 2.2.28-b1-02, in other words: branch 1 patch version 2. In the past, now and then the 4th, or 'patch', number, was used in 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 useful information to the end user, when you look at say, 2.2.28, and you last had 2.2.11, you can know with some certainty that inxi has no major new features, just fine tunings and bug fixes. And if you see one with 2.3.2, you will know that there is a new feature, almost, but not always, linked to one or more new line output items. 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 reflect in first version say, 2.9.01, then after a period of testing, where most little glitches are fixed, a move to 3.0.0. These almost never happen. I do not expect for example version 4.0 to ever happen after 3.0 (early 2018), unless so many new features are added that it actually hits 3.9, then it would roll over to 4. ================================================================================ BSD / UNIX -------------------------------------------------------------------------------- BSD support is not as complete as GNU/Linux support due to the fact some of the data simply is not available, or is structured in a way that makes it unique to each BSD, or is difficult to process. This fragmentation makes supporting BSDs far more difficult than it should be in the 21st century. The BSD support in inxi is an ongoing process, with more features being added as new data sources and types are discovered. Note that due to time/practicality constraints, in general, only the original BSD branches will be actively supported: FreeBSD+derived; OpenBSD+derived; NetBSD+derived. Other UNIX variants will generally only get the work required to make internal BSD flags get set and to remove visible output errors. -------------------------------------------------------------------------------- TRUE BSDs -------------------------------------------------------------------------------- All BSD issue reports unless trivial and obvious will require 1 of two things: 1. a full --debug 21 data dump so I don't have to spend days trying to get the information I need to resolve the issue, file by painful file, from the issue poster. This is only the start of the process, and realistically requires 2. to complete it. 2. direct SSH access to at least a comparable live BSD version/system, that is, if the issue is on a laptop, access has to be granted to the laptop, or a similar one. Option 2 is far preferred because in terms of my finite time on this planet of ours, the fact is, if I don't have direct (or SSH) access, I can't get much done, and the little I can get done will take 10 to 1000x longer than it should. That's my time spent (and sadly, with BSDs, largely lost), not yours. I decided I have to adopt this much more strict policy with BSDs after wasting untold hours on trying to get good BSD support, only to see that support break a few years down the road as the data inxi relied in changed structure or syntax, or the tools changed, or whatever else makes the BSDs such a challenge to support. In the end, I realized, the only BSDs that are well supported are ones that I have had direct access to for debugging and testing. 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 the internal inxi logic, and aren't too long. inxi sets initial internal flags to identify that it is a BSD system vs a GNU/Linux system, and preloads some data structures for BSD use, so make sure you understand what inxi is doing before you get into it. -------------------------------------------------------------------------------- APPLE CORPORATION OSX -------------------------------------------------------------------------------- Non-free/libre OSX is in my view a BSD in name only. It is the least Unix-like operating system I've ever seen that claims to be a Unix, its tools are mutated, its data randomly and non-standardly organized, and it totally fails to respect the 'spirit' of Unix, even though it might pass some random tests that certify a system as a 'Unix'. If you want me to use my time on OSX features or issues, you have to pay me, because Apple is all about money, not freedom (that's what the 'free' in 'free software' is referring to, not cost), and I'm not donating my finite time in support of non-free operating systems. ### EOF ###