Appearance
Ignore Rules
Ignore rules tell Kimura SCM which files and folders should be hidden from your workspace view and excluded from normal “what should I work on?” workflows (for example build outputs, generated files, and temporary artifacts).
Ignore rules are meant to keep the workspace clean and reduce noise. When needed, you can add exceptions to include specific items that would otherwise be ignored.
Ignore rules can be somewhat complicated and may require some attention to get right, especially for large repositories with many generated artifacts. Kimura SCM tries to help by providing presets for common repository types so you can start from a sensible baseline and then customize as needed.
How Ignore Rules Are Bound To Repositories
Ignore rules are configured per repository.
In the Visual Client’s Ignore rules tab, you’ll see a Selected repository field. That selection controls which repository’s ignore configuration you are viewing and editing.
.kscmignore (Repository Root)
Ignore rules can be stored in a file named .kscmignore at the root of each repository mapping in your workspace. This file is optional; if it does not exist, that repository starts with no custom ignore rules (until you create them in the UI).
If your workspace maps a repository at a subfolder (for example Game at /Game), the ignore file is located at that mapping root (for example /Game/.kscmignore).
Updating Ignore Rules Is A Versioned Change
When you change ignore rules, the client updates the repository’s .kscmignore file in your workspace. The .kscmignore file is versioned like any other file in the repository, so it is typically checked out (marked for add/edit) and submitted through a change list.
If your workspace maps multiple repositories, each repository can have different ignore rule sets. The workspace view may look like one tree, but ignore behavior follows the repository that each path belongs to via the repository map.
No Inheritance For Nested Repositories
If your workspace maps a repository inside another repository’s mapped folder tree (a “nested repository”), the nested repository does not inherit ignore rules from the parent repository mapping.
Even if the nested repository has no .kscmignore (and no custom ignore rules yet), it still starts with its own empty ignore configuration rather than using the parent’s rules.
Rule Sets And “From Directory”
Ignore rules are organized as rule sets that apply “from a directory”. Conceptually:
- each rule set is anchored at a specific directory path,
- and the ignore patterns in that rule set apply under that directory.
This is why the UI often has you create the initial rule set from the workspace tree by right‑clicking a directory.
Types Of Ignore Rules
Kimura SCM supports several kinds of ignore entries (as reflected in the Visual Client UI):
- Directories and files: ignore specific paths.
- Directory names: ignore directories by name.
- Extensions: ignore files by extension (for example
.tmp). - Exceptions: explicit includes that override ignores for specific paths.
How Ignore Rules Are Reflected In The Workspace
Hidden Items
When a file or folder matches ignore rules for its repository/path:
- it may not appear in the workspace tree,
- and it may not show up in views that focus on “work to do” (because it’s intentionally treated as noise).
Showing Ignored Items
If you need to see ignored items, enable:
- Settings → Show ignored directories and files
Exceptions
Exceptions let you “un-ignore” a specific path/pattern under an ignored area. Use exceptions when:
- a broad ignore rule hides too much, but
- you still want most generated files hidden.
Typical Workflows
Create A Custom Ignore Rule Set For A Directory
- In the workspace tree, right‑click a directory.
- Choose Ignore rules → Create custom ignore rules for directory.
- Open the Ignore rules tab and ensure the correct Selected repository is chosen.
Add A File/Folder To Ignore Quickly
From the workspace tree, you can use the Ignore rules right‑click submenu to add/remove items from ignore and exception lists. This is the fastest way to hide noisy artifacts as they appear.