Skip to content

Commit c0471d1

Browse files
committed
Add since annotations for long-names utils
1 parent 503cbf0 commit c0471d1

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

Codec/Archive/Tar/LongNames.hs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ import qualified Data.ByteString.Char8 as B
1212
import qualified Data.ByteString.Lazy.Char8 as BL
1313

1414
-- | Errors raised by 'decodeLongNames'.
15+
--
16+
-- @since 0.6.0.0
1517
data DecodeLongNamesError
1618
= TwoTypeKEntries
1719
-- ^ Two adjacent 'OtherEntryType' @\'K\'@ nodes.
@@ -28,6 +30,8 @@ instance Exception DecodeLongNamesError
2830
-- 'OtherEntryType' @\'K\'@ and 'OtherEntryType' @\'L\'@ nodes.
2931
--
3032
-- Input 'FilePath's must be POSIX file names, not native ones.
33+
--
34+
-- @since 0.6.0.0
3135
encodeLongNames
3236
:: GenEntry FilePath FilePath
3337
-> [Entry]
@@ -78,6 +82,8 @@ encodeLinkPath lnk = case toTarPath' lnk of
7882
-- 'OtherEntryType' @\'K\'@ and 'OtherEntryType' @\'L\'@ nodes.
7983
--
8084
-- Resolved 'FilePath's are still POSIX file names, not native ones.
85+
--
86+
-- @since 0.6.0.0
8187
decodeLongNames
8288
:: Entries e
8389
-> GenEntries FilePath FilePath (Either e DecodeLongNamesError)

0 commit comments

Comments
 (0)