From c5f1962e728c3c27e68424b0417e6098b0a84fbe Mon Sep 17 00:00:00 2001 From: Caleb Gardner Date: Sun, 29 Nov 2020 03:07:34 -0600 Subject: [PATCH] Some documentation changes --- file.go | 3 ++- reader.go | 4 ---- 2 files changed, 2 insertions(+), 5 deletions(-) diff --git a/file.go b/file.go index 66aa225..332ae7f 100644 --- a/file.go +++ b/file.go @@ -149,7 +149,8 @@ func (f *File) IsSymlink() bool { return f.filType == inode.BasicSymlinkType || f.filType == inode.ExtSymlinkType } -//SymlinkPath returns the path the symlink is pointing to. If the file ISN'T a symlink, will return an empty string +//SymlinkPath returns the path the symlink is pointing to. If the file ISN'T a symlink, will return an empty string. +//If a path begins with "/" then the symlink is pointing to an absolute path (starting from root, and not a file inside the archive) func (f *File) SymlinkPath() string { switch f.filType { case inode.BasicSymlinkType: diff --git a/reader.go b/reader.go index 13d8b9a..e62264f 100644 --- a/reader.go +++ b/reader.go @@ -21,13 +21,9 @@ var ( errIncompatibleCompression = errors.New("Compression type unsupported") //ErrCompressorOptions is returned if compressor options is present. It's not currently supported. errCompressorOptions = errors.New("Compressor options is not currently supported") - //ErrFragmentTableIssues is returned if there's trouble reading the fragment table when creating a reader. - //When this is returned, the reader is still returned. - errFragmentTableIssues = errors.New("Trouble while reading the fragment table") ) //Reader processes and reads a squashfs archive. -//TODO: Give a way to actually read files :P type Reader struct { r io.ReaderAt super superblock