Next: , Up: Submodules   [Contents][Index]

8.3.1 Listing Submodules

The command magit-list-submodules displays a list of the current repository’s submodules in a separate buffer. It’s also possible to display information about submodules directly in the status buffer of the super-repository by adding magit-insert-modules to the hook magit-status-sections-hook as described in Status Module Sections.

Command: magit-list-submodules

This command displays a list of the current repository’s populated submodules in a separate buffer.

It can be invoked by pressing RET on the section titled "Modules".

User Option: magit-submodule-list-columns

This option controls what columns are displayed by the command magit-list-submodules and how they are displayed.

Each element has the form (HEADER WIDTH FORMAT PROPS).

HEADER is the string displayed in the header. WIDTH is the width of the column. FORMAT is a function that is called with one argument, the repository identification (usually its basename), and with default-directory bound to the toplevel of its working tree. It has to return a string to be inserted or nil. PROPS is an alist that supports the keys :right-align, :pad-right and :sort.

The :sort function has a weird interface described in the docstring of tabulated-list--get-sort. Alternatively < and magit-repolist-version< can be used as those functions are automatically replaced with functions that satisfy the interface. Set :sort to nil to inhibit sorting; if unspecified, then the column is sortable using the default sorter.

You may wish to display a range of numeric columns using just one character per column and without any padding between columns, in which case you should use an appropriate HEADER, set WIDTH to 1, and set :pad-right to 9. + is substituted for numbers higher than 9.

Next: Submodule Transient, Up: Submodules   [Contents][Index]