r955 - in /trunk/packages/vim/debian: changelog policy/vim-policy.xml runtime/debian.vim.in
zack at users.alioth.debian.org
zack at users.alioth.debian.org
Mon Jun 18 12:01:46 UTC 2007
Author: zack
Date: Mon Jun 18 12:01:45 2007
New Revision: 955
URL: http://svn.debian.org/wsvn/pkg-vim/?sc=1&rev=955
Log:
work in progress, almost there...
Modified:
trunk/packages/vim/debian/changelog
trunk/packages/vim/debian/policy/vim-policy.xml
trunk/packages/vim/debian/runtime/debian.vim.in
Modified: trunk/packages/vim/debian/changelog
URL: http://svn.debian.org/wsvn/pkg-vim/trunk/packages/vim/debian/changelog?rev=955&op=diff
==============================================================================
--- trunk/packages/vim/debian/changelog (original)
+++ trunk/packages/vim/debian/changelog Mon Jun 18 12:01:45 2007
@@ -19,12 +19,15 @@
compiler. (Closes: #408338)
* Added the new Debian VIM Policy to the "vim-doc" package, overriding the
old unenforced one
+ * debian/runtime/debian.vim.in
+ - removing /usr/share/vim/addons/{,after/} from the vim runtimepath:
+ according to the VIM policy addons should not be enabled per default,
+ but manually using vim-addon-manager
* debian/control
- - split the build paths for binary-arch and binary-indep targets
- added build deps on docbook stuff to build the policy (note that this
includes lynx, due to #387035)
- -- James Vega <jamessan at debian.org> Sun, 17 Jun 2007 17:59:42 +0100
+ -- Stefano Zacchiroli <zack at debian.org> Mon, 18 Jun 2007 12:25:55 +0100
vim (1:7.1-000+1) unstable; urgency=low
Modified: trunk/packages/vim/debian/policy/vim-policy.xml
URL: http://svn.debian.org/wsvn/pkg-vim/trunk/packages/vim/debian/policy/vim-policy.xml?rev=955&op=diff
==============================================================================
--- trunk/packages/vim/debian/policy/vim-policy.xml (original)
+++ trunk/packages/vim/debian/policy/vim-policy.xml Mon Jun 18 12:01:45 2007
@@ -21,16 +21,115 @@
&legal;
</articleinfo>
+ <section id="nutshell">
+ <title>&vim; Addon Packaging in a Nutshell</title>
+
+ <warning> <para> This section contains a brief howto of what to do to
+ package a &vim; addon (plugin, syntax definition, ...) in &debian;.
+ This section is not the full policy nor the guidelines for doing that;
+ have a look at the remainder of this document for such information.
+ </para> </warning>
+
+ <para> So you've found on <ulink url="http://www.vim.org">vim.org</ulink> a
+ cool extra feature for your beloved editor (&vim;) and you want it to be
+ packages in &debian;. It's as easy as implementing the followin 4 steps:
+
+ <orderedlist numeration="arabic">
+
+ <listitem> <para> create a <code>architecture: all</code>
+ <filename>.deb</filename> binary package called
+ <application>vim-<replaceable>ADDON</replaceable></application>,
+ where <replaceable>ADDON</replaceable> is the addon name. See <xref
+ linkend="addon-packages" /> for more info on this. </para>
+ </listitem>
+
+ <listitem> <para> makes your package ship all the files composing your
+ addon (usually <filename>.vim</filename> and
+ <filename>.txt</filename> files) under
+ <filename>/usr/share/vim/addons/</filename>. The files should be
+ shipped as a file and directory tree isomorphic to what you want to
+ see in a runtime &vim; directory. So if for example the addon
+ documentation says that something should be installed as
+ <filename>plugin/foo.vim</filename> then you should ship it as
+ <filename>/usr/share/vim/addons/plugin/foo.vim</filename>. See <xref
+ linkend="addon-structure" /> for more info on this. </para>
+ </listitem>
+
+ <listitem> <para>create a
+ <filename>vim-<replaceable>ADDON</replaceable>.yaml</filename>
+ registry file for your addon and ship it as
+ <filename>/usr/share/vim/registry/vim-<replaceable>ADDON</replaceable>.yaml</filename>.
+ You can find documentation on how to write a registry file in <xref
+ linkend="registry-entry" /> and cut&paste-ready examples in
+ <xref linkend="registry-examples" />. If the addon you are
+ packaging does not provide a way to disable it consider patching it
+ so that it is possible, put in your registry entry the appropriate
+ <emphasis>disabledby</emphasis> field, and forward the patch
+ upstream. </para> </listitem>
+
+ <listitem> <para> <code>Recommend: vim-addon-manager</code> in your
+ <filename>debian/control</filename> and write into
+ <filename>README.Debian</filename> something like: <blockquote>
+ <para> Dear user, this package provides the vim addon
+ <replaceable>ADDON</replaceable>, but it is not enable per
+ default. If you want to enable it for your user account just
+ execute <userinput>vim-addons install
+ <replaceable>ADDON</replaceable></userinput>. Similarly, to
+ enable it for all users of this system just execute (as root)
+ <userinput>vim-addons -w install
+ <replaceable>ADDON</replaceable></userinput>.
+ <command>vim-addons</command> is provided by the
+ <application>vim-addon-manager</application> package, have a
+ look at its manpage for more information. </para> </blockquote>
+ See <xref linkend="tools" /> for more info on this. </para>
+ </listitem>
+
+ </orderedlist>
+
+ That's it! Easy, isn't it? </para>
+
+ </section>
+
<section id="legacy-packaging">
- <title>The &vim; Editor in Debian</title>
-
- <para> <emphasis>TODO</emphasis> brief description of &vim;
- packaging in &debian;, salient info like what is the runtime path
- and how &vim; has been split in packages </para>
+ <title>&vim; Packaging</title>
+
+ <para> Here you can find a brief overview of how the &vim; editor is
+ packaged in &debian; and a few concepts useful later; if you are
+ just interested in the guidelines for packaging addons skip to
+ <xref linkend="addon-packaging" />. </para>
+
+ <para> The &vim; editor is split in &debian; as several binary
+ packages. The key splitting is according to variants, a &vim;
+ <emphasis>variant</emphasis> is a particular version of the
+ <filename>/usr/bin/vim</filename> executable built with a given
+ set of (<application>configure</application>) option. Examples of
+ variants provided in &debian; are: <ulink
+ url="http://packages.debian.org/unstable/editors/vim-tiny"><application>vim-tiny</application></ulink>,
+ <ulink
+ url="http://packages.debian.org/unstable/editors/vim"><application>vim</application></ulink>,
+ <ulink
+ url="http://packages.debian.org/unstable/editors/vim-perl"><application>vim-perl</application></ulink>,
+ <ulink
+ url="http://packages.debian.org/unstable/editors/vim-full"><application>vim-full</application></ulink>.
+ Have a look at their full descriptions for their characteristics.
+ The actual <filename>/usr/bin/vim</filename> file is managed via
+ the alternative mechanism and point to one of the variants.
+ </para>
+
+ <para> Another relevant binary package is <ulink
+ url="http://packages.debian.org/unstable/editors/vim-runtime"><application>vim-runtime</application></ulink>
+ which ships the &vim; runtime environment distributed upstream
+ together with the editor. </para>
+
+ <para> TODO FINQUI </para>
+
+ <para> <emphasis>TODO</emphasis> brief description of &vim; packaging in
+ &debian;, salient info like what is the runtime path and how &vim; has
+ been split in packages </para>
</section>
- <section id="addons-packaging">
+ <section id="addon-packaging">
<title>Packaging of &vim; Addons</title>
<para> With the term (&vim;) <emphasis>addon</emphasis> we will
@@ -41,7 +140,7 @@
indentation definitions, generic and filetype-specific plugins,
... </para>
- <section id="addons-structure">
+ <section id="addon-structure">
<title>Addon Structure</title>
<para> An addon is usually composed of a set of
@@ -98,7 +197,7 @@
</section>
- <section>
+ <section id="addon-packages">
<title>Addon Packages</title>
<para> Each non-trivial addon<footnote> <para> meaning with
@@ -143,7 +242,7 @@
</section>
- <section>
+ <section id="registry-entry">
<title>Registry Entries</title>
<para> The following information should be made available for each
@@ -211,7 +310,7 @@
<xref linkend="registry-examples" /> to learn by example.
</para>
- <para> <emphasis>TODO</emphasis> what to do in the postinst ...
+ <para> <emphasis>TODO</emphasis> what to do in the postinst ... (nothing!)
</para>
</section>
@@ -224,6 +323,9 @@
<para> <emphasis>TODO</emphasis> brief mention of
<application>vim-addons</application> and what it does, pointing
to the manpage </para>
+
+ <para> <emphasis>TODO</emphasis> mention the needed Recommend:
+ vim-addon-manager </para>
</section>
Modified: trunk/packages/vim/debian/runtime/debian.vim.in
URL: http://svn.debian.org/wsvn/pkg-vim/trunk/packages/vim/debian/runtime/debian.vim.in?rev=955&op=diff
==============================================================================
--- trunk/packages/vim/debian/runtime/debian.vim.in (original)
+++ trunk/packages/vim/debian/runtime/debian.vim.in Mon Jun 18 12:01:45 2007
@@ -1,7 +1,7 @@
" Debian system-wide default configuration Vim
-set runtimepath=~/.vim,/var/lib/vim/addons,/usr/share/vim/addons,/usr/share/vim/vimfiles,/usr/share/vim/@VIMCUR@,/usr/share/vim/vimfiles/after,/usr/share/vim/addons/after,/var/lib/vim/addons/after,~/.vim/after
+set runtimepath=~/.vim,/var/lib/vim/addons,/usr/share/vim/vimfiles,/usr/share/vim/@VIMCUR@,/usr/share/vim/vimfiles/after,/var/lib/vim/addons/after,~/.vim/after
" Normally we use vim-extensions. If you want true vi-compatibility
" remove change the following statements
More information about the pkg-vim-maintainers
mailing list