Method

IdeVcspath_is_ignored

Declaration

gboolean
ide_vcs_path_is_ignored (
  IdeVcs* self,
  const gchar* path,
  GError** error
)

Description

This function acts like ide_vcs_is_ignored() except that it allows for using a regular file-system path.

It will check if the path is absolute or relative to the project directory and adjust as necessary.

For convenience, this function will return TRUE if path is NULL.

If self is NULL, only registered ignore patterns will be checked.

Parameters

path

Type: const gchar*

The path to check.

The argument can be NULL.

The data is owned by the caller of the method.

The value is a NUL terminated UTF-8 string.

error

Type: GError **

The return location for a recoverable error.

The argument can be NULL.

If the return location is not NULL, then you must initialize it to a NULL GError*.

The argument will be left initialized to NULL by the method if there are no errors.

In case of error, the argument will be set to a newly allocated GError; the caller will take ownership of the data, and be responsible for freeing it.

Return value

Type: gboolean

TRUE if the path should be ignored.

Thread safety: This function is safe to call from a thread as IdeVcs implementations are required to ensure this function is thread-safe.