[gnome-builder] doc: add more howto sections
- From: Christian Hergert <chergert src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-builder] doc: add more howto sections
- Date: Thu, 7 Sep 2017 04:32:48 +0000 (UTC)
commit bf2f97df4d6f5e3cda019d0cfdabda50298c605b
Author: Christian Hergert <chergert redhat com>
Date: Wed Sep 6 21:32:35 2017 -0700
doc: add more howto sections
doc/howto/index.rst | 2 ++
doc/howto/jump_to_definition.rst | 13 +++++++++++++
doc/howto/search_for_symbol.rst | 16 ++++++++++++++++
3 files changed, 31 insertions(+), 0 deletions(-)
---
diff --git a/doc/howto/index.rst b/doc/howto/index.rst
index 5cd6790..af8f0c7 100644
--- a/doc/howto/index.rst
+++ b/doc/howto/index.rst
@@ -14,4 +14,6 @@ Contents
indentation
search_and_replace
+ jump_to_definition
+ search_for_symbol
diff --git a/doc/howto/jump_to_definition.rst b/doc/howto/jump_to_definition.rst
new file mode 100644
index 0000000..3c8549b
--- /dev/null
+++ b/doc/howto/jump_to_definition.rst
@@ -0,0 +1,13 @@
+##################
+Jump to Definition
+##################
+
+Builder supports jumping to the definition of a symbol.
+It is a quick and easy way to navigate the source of your project.
+
+If you're using thd default or Emacs-based keybindings, use ``Alt+.`` while the insertion mark is on the
symbol name.
+If you're using Vim-based keybindings, use the ``gd`` while the cursor is on the symbol name.
+
+If you're located at the declaration of a symbol (such as in a header file), you can jump to the
implimentation using this method.
+This requires that the ``code-index`` plugin is enabled.
+
diff --git a/doc/howto/search_for_symbol.rst b/doc/howto/search_for_symbol.rst
new file mode 100644
index 0000000..5d52b33
--- /dev/null
+++ b/doc/howto/search_for_symbol.rst
@@ -0,0 +1,16 @@
+#####################
+Searching for Symbols
+#####################
+
+Builder supports searching for a symbol by name.
+
+First, focus the search entry with ``Control+.``.
+Then start typing the name of the symbol.
+Fuzzy searching is supported.
+For example, searching for ``GcWin`` might match the symbol ``GcalWindow``.
+
+Press ``Up`` or ``Down`` arrows to move between the results.
+Press ``Enter`` to activate the search result and jump to the symbol.
+You can press ``Escape`` to return to the editor.
+
+.. note:: This feature requires that the ``code-index`` plugin is enabled.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]