[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Re: prefixes of symbol names in psvn.el

From: Stefan Reichör <stefan_at_xsteve.at>
Date: 2005-10-11 22:09:51 CEST

Kalle Olavi Niemitalo <kon@iki.fi> writes:

> Currently, psvn.el assigns global meanings to symbols that match the
> following patterns:
> svn-status
> svn-status-*
> svn-log-edit-*
> svn-log-view-*
> svn-prop-edit-*
> svn-*
> (svn-add-face, svn-alist, svn-alist-convert-widget, svn-browse-url,
> svn-browse-url-function, svn-global-keymap, svn-global-trac-map,
> svn-highlight, svn-insert-line-in-status-buffer,
> svn-log-revision-at-point, svn-parse-rev-num,
> svn-parse-status-result, svn-resolve-conflicts,
> svn-resolve-conflicts-ediff, svn-run-svn,
> svn-start-of-file-list-line-number, svn-temp-suffix,
> svn-wc-adm-dir-name, svn-xemacsp)
> svn-process-*
> (svn-process-cmd, svn-process-filter, svn-process-kill,
> svn-process-send-string, svn-process-sentinel,
> svn-process-sentinel-fixup-path-separators)
> svn-ediff-*
> (svn-ediff-exit-hook, svn-ediff-startup-hook)
> svn-trac-*
> (svn-trac-browse-changeset, svn-trac-browse-ticket,
> svn-trac-browse-timeline, svn-trac-project-root)
> psvn (defgroup, provide)
> psvn-faces (defgroup)
> *
> (match-string-no-properties, point-at-bol, point-at-eol, puthash,
> read-directory-name)

That is a nice summary of the used prefixes.

> According to (elisp)Coding Conventions ("If a package needs to define"
> ..), at least the compatibility definitions should be renamed to begin
> with a "package prefix".

You are absolutely correct, that the compatibility functions should
also use the svn- prefix. Could you do that?

> Am I correct in assuming that:
> "svn-" is the package prefix used in psvn.el. There are also longer
> prefixes which clarify the code and help symbol completion, but they
> are not intended to prevent name clashes with other packages. All
> interactive commands meant to be used only in a specific mode should
> have names beginning with the name of that mode: for example,
> "svn-status-add-file" in "svn-status-mode". "psvn" should be used
> only in names of files, customization groups, and features. If SVK
> support is ever added, it should use "svn-svk-" when no existing
> prefix is applicable.
> If so, this should be added as a comment in psvn.el, I think.

Your description sounds good, please add it as comment.

> trunk/tools/dev/svn-dev.el also uses names beginning with "svn-". I
> haven't checked whether there are any conflicts between that and psvn.el.

I don't use svn-dev.el

* Is anyone experiencing conflicts, when using that two packages?
* Would it make sense to merge svn-dev.el to psvn.el, or does
  that package contain specific code that is only useful for the
  development of svn itself?


To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Tue Oct 11 22:15:32 2005

This is an archived mail posted to the Subversion Dev mailing list.

This site is subject to the Apache Privacy Policy and the Apache Public Forum Archive Policy.