diff --git a/docs/man-pages.rst b/docs/man-pages.rst index 51934663b6..b0c75da344 100644 --- a/docs/man-pages.rst +++ b/docs/man-pages.rst @@ -31,6 +31,7 @@ Man pages ctags-lang-sql(7) ctags-lang-systemtap(7) ctags-lang-tcl(7) + ctags-lang-terraform(7) ctags-lang-verilog(7) readtags(1) diff --git a/docs/man/ctags-lang-terraform.7.rst b/docs/man/ctags-lang-terraform.7.rst new file mode 100644 index 0000000000..dd4c59bf30 --- /dev/null +++ b/docs/man/ctags-lang-terraform.7.rst @@ -0,0 +1,47 @@ +.. _ctags-lang-terraform(7): + +============================================================== +ctags-lang-terraform +============================================================== + +Random notes about tagging Terraform files with Universal Ctags + +:Version: 6.0.0 +:Manual group: Universal Ctags +:Manual section: 7 + +SYNOPSIS +-------- +| **ctags** ... --languages=+Terraform ... +| **ctags** ... --language-force=Terraform ... +| **ctags** ... --map-Terraform=+.tf ... +| +| **ctags** ... --extras=+{reference} --languages=+TerraformVariables ... +| **ctags** ... --extras=+{reference} --language-force=TerraformVariables ... +| **ctags** ... --extras=+{reference} --map-Terraform=+.tfvars ... + +DESCRIPTION +----------- +This man page gathers random notes about tagging Terraform files. + +TIPS +----------- + +Extracting variables assigned in Variable definitions +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Specify ``--extras=+{reference}`` and ``--languages=+TerraformVariables`` +to extract variables assigned in variables definitions (`*.tfvars`). +The TerraformVariables parser extracts variables in `*.tfvars` files +with ``variable`` kind with ``assigned`` role of ``Terraform`` language. + +KNOWN BUGS +---------- +* The parser doesn't ignore strings inside a block comment (``/* ... */``). + +* The parser doesn't extract variables defined with ``locals`` keyword. + +SEE ALSO +-------- +:ref:`ctags(1) `, +`Configuration Syntax `_ (https://developer.hashicorp.com/terraform/language/syntax/configuration), +`Variable Definitions (.tfvars) Files `_ (https://developer.hashicorp.com/terraform/language/values/variables#variable-definitions-tfvars-files) diff --git a/man/GNUmakefile.am b/man/GNUmakefile.am index ba59833865..ecd562aa6f 100644 --- a/man/GNUmakefile.am +++ b/man/GNUmakefile.am @@ -42,6 +42,7 @@ GEN_IN_MAN_FILES = \ ctags-lang-sql.7 \ ctags-lang-systemtap.7 \ ctags-lang-tcl.7 \ + ctags-lang-terraform.7 \ ctags-lang-verilog.7 \ \ readtags.1 \ diff --git a/man/ctags-lang-terraform.7.rst.in b/man/ctags-lang-terraform.7.rst.in new file mode 100644 index 0000000000..a95b1648b7 --- /dev/null +++ b/man/ctags-lang-terraform.7.rst.in @@ -0,0 +1,47 @@ +.. _ctags-lang-terraform(7): + +============================================================== +ctags-lang-terraform +============================================================== +--------------------------------------------------------------------- +Random notes about tagging Terraform files with Universal Ctags +--------------------------------------------------------------------- +:Version: @VERSION@ +:Manual group: Universal Ctags +:Manual section: 7 + +SYNOPSIS +-------- +| **@CTAGS_NAME_EXECUTABLE@** ... --languages=+Terraform ... +| **@CTAGS_NAME_EXECUTABLE@** ... --language-force=Terraform ... +| **@CTAGS_NAME_EXECUTABLE@** ... --map-Terraform=+.tf ... +| +| **@CTAGS_NAME_EXECUTABLE@** ... --extras=+{reference} --languages=+TerraformVariables ... +| **@CTAGS_NAME_EXECUTABLE@** ... --extras=+{reference} --language-force=TerraformVariables ... +| **@CTAGS_NAME_EXECUTABLE@** ... --extras=+{reference} --map-Terraform=+.tfvars ... + +DESCRIPTION +----------- +This man page gathers random notes about tagging Terraform files. + +TIPS +----------- + +Extracting variables assigned in Variable definitions +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Specify ``--extras=+{reference}`` and ``--languages=+TerraformVariables`` +to extract variables assigned in variables definitions (`*.tfvars`). +The TerraformVariables parser extracts variables in `*.tfvars` files +with ``variable`` kind with ``assigned`` role of ``Terraform`` language. + +KNOWN BUGS +---------- +* The parser doesn't ignore strings inside a block comment (``/* ... */``). + +* The parser doesn't extract variables defined with ``locals`` keyword. + +SEE ALSO +-------- +ctags(1), +`Configuration Syntax `_ (https://developer.hashicorp.com/terraform/language/syntax/configuration), +`Variable Definitions (.tfvars) Files `_ (https://developer.hashicorp.com/terraform/language/values/variables#variable-definitions-tfvars-files)