Add changelog, docs + config changes

jj-vcs · Jan 26, 2025 · 60867a0 · 60867a0
1 parent f6e64c5
commit 60867a0
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 44 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -145,6 +145,9 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 * `[diff.<format>]` configuration now applies to `.diff().<format>()` commit
   template methods.
 
+* Add support for just ignoring Git LFS files by parsing `.gitattribute` files and automatically 
+  adding the relevant files to the internal ignore list
+
 ## [0.25.0] - 2025-01-01
 
 ### Release highlights

diff --git a/cli/src/config-schema.json b/cli/src/config-schema.json
@@ -39,11 +39,7 @@
                 "conflict-marker-style": {
                     "type": "string",
                     "description": "Conflict marker style to use when materializing conflicts in the working copy",
-                    "enum": [
-                        "diff",
-                        "snapshot",
-                        "git"
-                    ],
+                    "enum": ["diff", "snapshot", "git"],
                     "default": "diff"
                 }
             },
@@ -85,21 +81,13 @@
                 },
                 "color": {
                     "description": "Whether to colorize command output",
-                    "enum": [
-                        "always",
-                        "never",
-                        "debug",
-                        "auto"
-                    ],
+                    "enum": ["always", "never", "debug", "auto"],
                     "default": "auto"
                 },
                 "paginate": {
                     "type": "string",
                     "description": "Whether or not to use a pager",
-                    "enum": [
-                        "never",
-                        "auto"
-                    ],
+                    "enum": ["never", "auto"],
                     "default": "auto"
                 },
                 "pager": {
@@ -113,11 +101,7 @@
                     "properties": {
                         "format": {
                             "description": "The diff format to use",
-                            "enum": [
-                                "color-words",
-                                "git",
-                                "summary"
-                            ],
+                            "enum": ["color-words", "git", "summary"],
                             "default": "color-words"
                         },
                         "tool": {
@@ -191,11 +175,11 @@
                 "watchman": {
                     "type": "object",
                     "properties": {
-                      "register_snapshot_trigger": {
-                        "type": "boolean",
-                        "default": false,
-                        "description": "Whether to use triggers to monitor for changes in the background."
-                      }
+                        "register_snapshot_trigger": {
+                            "type": "boolean",
+                            "default": false,
+                            "description": "Whether to use triggers to monitor for changes in the background."
+                        }
                     }
                 }
             }
@@ -230,14 +214,14 @@
                     "pattern": "^#[0-9a-fA-F]{6}$"
                 },
                 "colors": {
-                  "oneOf": [
-                    {
-                        "$ref": "#/properties/colors/definitions/colorNames"
-                    },
-                    {
-                        "$ref": "#/properties/colors/definitions/hexColor"
-                    }
-                  ]
+                    "oneOf": [
+                        {
+                            "$ref": "#/properties/colors/definitions/colorNames"
+                        },
+                        {
+                            "$ref": "#/properties/colors/definitions/hexColor"
+                        }
+                    ]
                 },
                 "basicFormatterLabels": {
                     "enum": [
@@ -389,6 +373,11 @@
                     "type": "string",
                     "description": "Path to the git executable",
                     "default": "git"
+                },
+                "ignore-lfs-files": {
+                    "type": "boolean",
+                    "description": "Whether jj ignores files handled by git lfs or not",
+                    "default": false
                 }
             }
         },
@@ -416,12 +405,9 @@
                         "default": [0]
                     },
                     "diff-invocation-mode": {
-                      "description": "Invoke the tool with directories or individual files",
-                      "enum": [
-                        "dir",
-                        "file-by-file"
-                      ],
-                      "default": "dir"
+                        "description": "Invoke the tool with directories or individual files",
+                        "enum": ["dir", "file-by-file"],
+                        "default": "dir"
                     },
                     "edit-args": {
                         "type": "array",
@@ -529,10 +515,7 @@
                     "default": "false"
                 },
                 "max-new-file-size": {
-                    "type": [
-                        "integer",
-                        "string"
-                    ],
+                    "type": ["integer", "string"],
                     "description": "New files with a size in bytes above this threshold are not snapshotted, unless the threshold is 0",
                     "default": "1MiB"
                 }
@@ -616,7 +599,7 @@
                 }
             }
         },
-    "fix": {
+        "fix": {
             "type": "object",
             "description": "Settings for jj fix",
             "properties": {

diff --git a/docs/config.md b/docs/config.md
@@ -1258,6 +1258,17 @@ particular binary, you can:
 executable-path = "/path/to/git"
 ```
 
+### Ignore Git LFS Files
+
+By default Git LFS files are **not** handled by `jj`. This will result in `jj` showing
+changes in these files, even if they are unchanged. You can configure `jj` to ignore these
+files by instructing it to parse the relevant `.gitattributes` files
+
+```tom
+[git]
+ignore-lfs-files = -rue
+```
+
 ## Filesystem monitor
 
 In large repositories, it may be beneficial to use a "filesystem monitor" to