go/vim at 2dc751ac21ce8f7c9bf33a8ffd5c5f1b86dc0c17 - go

qbit/go

mirror of https://github.com/golang/go synced 2024-10-05 04:31:22 -06:00

History

Bill Thiede 27f7e3b217 misc/vim: test.sh seems to only work on Mac OS X. cmp(1) on FreeBSD requires two file arguments. grep -P on Linux (at least Ubuntu 12.04) is described in the man page as "This is highly experimental" and doesn't seem to work. On FreeBSD the man page states "This option is not supported in FreeBSD." Needed this to work while debugging some funky behavior of 'Import' in my local vim setup. R=golang-dev, dsymonds CC=golang-dev https://golang.org/cl/7675043		2013-05-14 09:54:16 -07:00
..
autoload/go	misc/vim: fix for autocompletion	2012-08-28 03:59:16 +08:00
ftdetect	misc/vim: restore fileencodings.	2012-03-14 18:43:01 +11:00
ftplugin/go	misc/vim: test.sh seems to only work on Mac OS X.	2013-05-14 09:54:16 -07:00
indent
plugin	misc/vim: make Godoc command work with "log.Print".	2013-03-26 17:39:46 +11:00
syntax	misc/vim: add error type.	2011-11-01 21:47:07 -04:00
readme.txt	misc/vim: update installation instructions to work better with some Linux distributions.	2013-02-18 14:03:47 +11:00

readme.txt

Vim plugins for Go (http://golang.org)
======================================

To use all the Vim plugins, add these lines to your $HOME/.vimrc.

  " Some Linux distributions set filetype in /etc/vimrc.
  " Clear filetype flags before changing runtimepath to force Vim to reload them.
  filetype off
  filetype plugin indent off
  set runtimepath+=$GOROOT/misc/vim
  filetype plugin indent on
  syntax on

If you want to select fewer plugins, use the instructions in the rest of
this file.

Vim syntax highlighting
-----------------------

To install automatic syntax highlighting for GO programs:

  1. Copy or link the filetype detection script to the ftdetect directory
     underneath your vim runtime directory (normally $HOME/.vim/ftdetect)
  2. Copy or link syntax/go.vim to the syntax directory underneath your vim
     runtime directory (normally $HOME/.vim/syntax). Linking this file rather
     than just copying it will ensure any changes are automatically reflected
     in your syntax highlighting.
  3. Add the following line to your .vimrc file (normally $HOME/.vimrc):

     syntax on

In a typical unix environment you might accomplish this using the following
commands:

  mkdir -p $HOME/.vim/ftdetect
  mkdir -p $HOME/.vim/syntax
  mkdir -p $HOME/.vim/autoload/go
  ln -s $GOROOT/misc/vim/ftdetect/gofiletype.vim $HOME/.vim/ftdetect/
  ln -s $GOROOT/misc/vim/syntax/go.vim $HOME/.vim/syntax
  ln -s $GOROOT/misc/vim/autoload/go/complete.vim $HOME/.vim/autoload/go
  echo "syntax on" >> $HOME/.vimrc


Vim filetype plugins
--------------------

To install one of the available filetype plugins:

  1. Same as 1 above.
  2. Copy or link one or more plugins from ftplugin/go/*.vim to the
     Go-specific ftplugin directory underneath your vim runtime directory
     (normally $HOME/.vim/ftplugin/go/*.vim).
  3. Add the following line to your .vimrc file (normally $HOME/.vimrc):

     filetype plugin on


Vim indentation plugin
----------------------

To install automatic indentation:

  1. Same as 1 above.
  2. Copy or link indent/go.vim to the indent directory underneath your vim
     runtime directory (normally $HOME/.vim/indent).
  3. Add the following line to your .vimrc file (normally $HOME/.vimrc):

     filetype indent on


Godoc plugin
------------

To install godoc plugin:

  1. Same as 1 above.
  2. Copy or link plugin/godoc.vim to $HOME/.vim/plugin/godoc,
     syntax/godoc.vim to $HOME/.vim/syntax/godoc.vim,
     and autoload/go/complete.vim to $HOME/.vim/autoload/go/complete.vim.