Function: project-root

project-root is a byte-compiled function defined in project.el.gz.

Signature

(project-root PROJECT)

Documentation

Return root directory of the current project.

It usually contains the main build file, dependencies configuration file, etc. Though neither is mandatory.

The directory name must be absolute.

Probably introduced at or before Emacs version 28.1.

Implementations

(project-root (PROJECT (head projectile))) in `projectile.el'.

Undocumented

(project-root (PROJECT ede-project)) in `ede.el'.

Undocumented

(project-root (PROJECT (head eglot--project))) in `eglot.el'.

Undocumented

(project-root (PROJECT (head vc))) in `project.el'.

Undocumented

(project-root (PROJECT (head transient))) in `project.el'.

Undocumented

(project-root PROJECT (NIL ((&context . project--within-roots-fallback) eql nil))) in `project.el'.

Undocumented

Source Code

;; Defined in /usr/src/emacs/lisp/progmodes/project.el.gz
(cl-defgeneric project-root (project)
  "Return root directory of the current project.

It usually contains the main build file, dependencies
configuration file, etc. Though neither is mandatory.

The directory name must be absolute.")