Whole bunch of changes and releases

This commit is contained in:
Yorhel 2018-01-29 14:32:46 +01:00
parent 07143cfb36
commit 54947f15c2
36 changed files with 3269 additions and 40 deletions

View file

@ -19,17 +19,18 @@ object is an array:
=head2 Versioning
The C<< <majorver> >> and C<< <minorver> >> elements indicate the version of the file
format. These are numbers with accepted values in the range of
C<< 0 <= version <= 10000 >>. Major version must be C<1>, minor version is currently C<0>. The
major version should increase if backwards-incompatible changes are made
(preferably never), the minor version can be increased to indicate additions to
the existing format.
The C<< <majorver> >> and C<< <minorver> >> elements indicate the version of
the file format. These are numbers with accepted values in the range of C<< 0
<= version <= 10000 >>. Major version must be C<1>. Minor version is C<0> for
ncdu 1.9 till 1.12, and C<1> since ncdu 1.13 for the addition of the extended
mode. The major version should increase if backwards-incompatible changes are
made (preferably never), the minor version can be increased to indicate
additions to the existing format.
=head2 Metadata
The C<< <metadata> >> element is a JSON object holding whatever (short)
metadata you'd want. This block is currently (1.9-1.12) ignored by ncdu when
metadata you'd want. This block is currently (1.9-1.13) ignored by ncdu when
importing, but it writes out the following keys when exporting:
=over
@ -109,7 +110,7 @@ C<< 0 <= dev < 2^64 >>.
Number. Inode number as reported by C<lstat().st_ino>. Together with the Device
ID this uniquely identifies a file in this dump. In the case of hard links, two
objects may appear with the same (C<dev>,C<ino>) combination. A value of 0 is
assumed if this field is absent. This is currently (ncdu 1.9-1.12) not a
assumed if this field is absent. This is currently (ncdu 1.9-1.13) not a
problem as long as the C<hlnkc> field is false, otherwise it will consider
everything with the same C<dev> and empty C<ino> values as a single hardlinked
file. Accepted values are in the range of C<< 0 <= ino < 2^64 >>.
@ -163,6 +164,37 @@ whatever else your system may support. If absent, C<false> is assumed.
=back
=head3 Extended information
In addition, the following fields are exported when I<extended information>
mode is enabled (available since ncdu 1.13). See the C<-e> flag in L<ncdu(1)>
for details.
=over
=item uid
Number, user ID who owns the file. Accepted values are in the range
C<< 0 <= uid < 2^31 >>.
=item gid
Number, group ID who owns the file. Accepted values are in the range
C<< 0 <= uid < 2^31 >>.
=item mode
Number, the raw file mode as returned by L<lstat(3)>. For Linux systems, see
L<inode(7)> for the interpretation of this field. Accepted range:
C<< 0 <= mode < 2^16 >>.
=item mtime
Number, last modification time as a UNIX timestamp. Accepted range:
C<< 0 <= mtime < 2^64 >>.
=back
=head2 Miscellaneous notes
As mentioned above, file/directory names are B<not> converted to any specific