Skip to content

Commit

Permalink
entry_type: Fix doc comments for PAX bits (#359)
Browse files Browse the repository at this point in the history
Someone copy-pasted the GNU link comments.  While we're
here, link to the PAX site.

Signed-off-by: Colin Walters <walters@verbum.org>
  • Loading branch information
cgwalters authored Jun 4, 2024
1 parent c74d62a commit ac38b1e
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions src/entry_type.rs
Original file line number Diff line number Diff line change
Expand Up @@ -181,12 +181,18 @@ impl EntryType {
self == &EntryType::GNULongLink
}

/// Returns whether this type represents a GNU long name header.
/// Returns whether this type represents PAX global extensions, that
/// should affect all following entries. For more, see [PAX].
///
/// [PAX]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/pax.html
pub fn is_pax_global_extensions(&self) -> bool {
self == &EntryType::XGlobalHeader
}

/// Returns whether this type represents a GNU long link header.
/// Returns whether this type represents PAX local extensions; these
/// only affect the current entry. For more, see [PAX].
///
/// [PAX]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/pax.html
pub fn is_pax_local_extensions(&self) -> bool {
self == &EntryType::XHeader
}
Expand Down

0 comments on commit ac38b1e

Please sign in to comment.