Document file for file format

Issue #8

docs/file_format/file.md

@@ -0,0 +1,51 @@
+# File
+
+A file entry describes information about a file that should be linked in a
+segment.
+
+Every attribute listed is optional unless explicitly stated.
+
+## `path`
+
+This is **required**.
+
+Path to the file.
+
+The `base_path` from settings is used as a base for the emitted path.
+
+### Example
+
+```yaml
+segments:
+  - name: boot
+    files:
+      - { path: src/boot/boot_main.o }
+```
+
+### Valid values
+
+Any valid path.
+
+## `kind`
+
+Specifies the type of file entry.
+
+### Example
+
+```yaml
+segments:
+  - name: boot
+    files:
+      - { path: src/boot/utils.o, kind: object }
+```
+
+### Valid values
+
+- `object`: The path points to a relocatable object file.
+
+### Default value
+
+Guessed from `path` using the following file extensions:
+
+- `.o`: `Object`.
+- Anything else: `Object`.

docs/file_format/segments.md

@@ -36,7 +36,7 @@ List of files belonging to this segment.
 
 The order of the list implies the order on which the files will be emitted.
 
-To see customization options for each file check the [files.md](files.md)
+To see customization options for each file check the [file.md](file.md)
 document.
 
 ### Example

slinky/src/document.rs

@@ -5,7 +5,7 @@ use std::{fs, path::Path};
 
 use serde::Deserialize;
 
-use crate::{Segment, Settings, SlinkyError};
+use crate::{FileKind, Segment, Settings, SlinkyError};
 
 #[derive(Deserialize, PartialEq, Debug)]
 pub struct Document {
@@ -43,6 +43,11 @@ impl Document {
             segment
                 .wildcard_sections
                 .get_or_insert(document.settings.wildcard_sections);
+
+            for file in &mut segment.files {
+                // TODO: guess based on file extension
+                file.kind.get_or_insert(FileKind::Object);
+            }
         }
 
         Ok(document)

slinky/src/file_info.rs

@@ -10,10 +10,5 @@ use crate::file_kind::FileKind;
 pub struct FileInfo {
     pub path: PathBuf,
 
-    #[serde(default = "default_fileinfo_kind")]
-    pub kind: FileKind,
-}
-
-fn default_fileinfo_kind() -> FileKind {
-    FileKind::Object
+    pub kind: Option<FileKind>,
 }

slinky/src/file_kind.rs

@@ -4,6 +4,7 @@
 use serde::Deserialize;
 
 #[derive(Deserialize, PartialEq, Debug)]
+#[serde(rename_all = "snake_case")]
 pub enum FileKind {
     Object,
     Archive,

slinky/src/linker_writer.rs

@@ -208,7 +208,7 @@ impl LinkerWriter<'_> {
             };
 
             // TODO: figure out glob support
-            match file.kind {
+            match file.kind.as_ref().unwrap() {
                 FileKind::Object => {
                     self.writeln(&format!("{}({}{});", path.display(), section, wildcard));
                 }