CL-Sack is a Common Lisp library for making and manipulating Sack files.
| Revision | 5add853fae5efaf66482ee0f82c72353dcdd68b1 (tree) |
|---|---|
| Time | 2018-10-20 10:42:30 |
| Author | Alexa Jones-Gonzales <alexa@part...> |
| Commiter | Alexa Jones-Gonzales |
* Add note about +MAX-ENTRY-TYPES+
* Fix code wrapping
src/globals.lisp (diff)| @@ -29,56 +29,65 @@ | ||
| 29 | 29 | |
| 30 | 30 | (alexandria:define-constant +entry-type-sack+ 65534 |
| 31 | 31 | :test 'equal |
| 32 | - :documentation "The Entry Type Number for Entries of type SACK") | |
| 32 | + :documentation "The Entry Type Number for Entries of type SACK.") | |
| 33 | 33 | |
| 34 | 34 | (alexandria:define-constant +entry-type-data+ 65535 |
| 35 | 35 | :test 'equal |
| 36 | - :documentation "The Entry Type Number for Entries of type DATA") | |
| 36 | + :documentation "The Entry Type Number for Entries of type DATA.") | |
| 37 | 37 | |
| 38 | 38 | (alexandria:define-constant +entry-type-name-sack+ "SACK" |
| 39 | 39 | :test 'equal |
| 40 | - :documentation "The Name of the Entry Type for Entries of type SACK") | |
| 40 | + :documentation "The Name of the Entry Type for Entries of type | |
| 41 | + SACK.") | |
| 41 | 42 | |
| 42 | 43 | (alexandria:define-constant +entry-type-name-data+ "DATA" |
| 43 | 44 | :test 'equal |
| 44 | - :documentation "The name of the Entry Type for Entries of type DATA") | |
| 45 | + :documentation "The name of the Entry Type for Entries of type | |
| 46 | + DATA.") | |
| 45 | 47 | |
| 46 | 48 | (alexandria:define-constant +max-entry-name-length+ 65536 |
| 47 | 49 | :test 'equal |
| 48 | - :documentation "The maximum length of a Sack Entry's name") | |
| 50 | + :documentation "The maximum length of a Sack Entry's name.") | |
| 49 | 51 | |
| 50 | 52 | (alexandria:define-constant +max-entry-types+ 65534 |
| 51 | 53 | :test 'equal |
| 52 | - :documentation "The maximum number of user-definable Entry Types in a Sack file") | |
| 54 | + :documentation "The maximum number of user-definable Entry Types in | |
| 55 | + a Sack file. Note that this does not include the two built-in Entry | |
| 56 | + Types.") | |
| 53 | 57 | |
| 54 | 58 | (alexandria:define-constant +max-metadata-pairs+ 65536 |
| 55 | 59 | :test 'equal |
| 56 | - :documentation "The maximum number of metadata pairs a Sack File or Sack Entry can have") | |
| 60 | + :documentation "The maximum number of metadata pairs a Sack File or | |
| 61 | + Sack Entry can have.") | |
| 57 | 62 | |
| 58 | 63 | (alexandria:define-constant |
| 59 | 64 | +where-to-store-entry-types-table-offset+ |
| 60 | 65 | (+ 6 2 4 8) ;; Magic + Version + Sack Type + Num Entries |
| 61 | 66 | :test 'equal |
| 62 | 67 | :documentation |
| 63 | - "Where in the header the offset of the Entry Types Table should be written") | |
| 68 | + "Where in the header the offset of the Entry Types Table should be | |
| 69 | + written.") | |
| 64 | 70 | |
| 65 | 71 | (alexandria:define-constant |
| 66 | 72 | +where-to-store-entries-table-offset+ |
| 67 | 73 | (+ +where-to-store-entry-types-table-offset+ 16) |
| 68 | 74 | :test 'equal |
| 69 | 75 | :documentation |
| 70 | - "Where in the header the offset of the Entries Table should be written") | |
| 76 | + "Where in the header the offset of the Entries Table should be | |
| 77 | + written.") | |
| 71 | 78 | |
| 72 | 79 | (alexandria:define-constant |
| 73 | 80 | +where-to-store-sack-metadata-table-offset+ |
| 74 | 81 | (+ +where-to-store-entries-table-offset+ 16) |
| 75 | 82 | :test 'equal |
| 76 | 83 | :documentation |
| 77 | - "Where in the header the offset of the Sack Metadata Table should be written") | |
| 84 | + "Where in the header the offset of the Sack Metadata Table should be | |
| 85 | + written.") | |
| 78 | 86 | |
| 79 | 87 | (alexandria:define-constant |
| 80 | 88 | +where-to-store-entries-metadata-table-offset+ |
| 81 | 89 | (+ +where-to-store-sack-metadata-table-offset+ 16) |
| 82 | 90 | :test 'equal |
| 83 | 91 | :documentation |
| 84 | - "Where in the header the offset of the Entries Metadata Table should be written") | |
| 92 | + "Where in the header the offset of the Entries Metadata Table should | |
| 93 | + be written.") |
Fork