Re: [Sbcl-devel] Proposed documentation patch

[Christophe R. <cs...@ca...>]

Robert Goldman <rpg...@si...> writes:

> I'm enclosing a patch file that adds docstrings to
> sb-ext:disable-debugger and sb-ext:enable-debugger.
>
> It also adds these functions (and some other information about the
> debugger) to the function and concept indices.
>
> This is all intended to make it easier to find information about
> controlling the debugger.

Thanks.  I've merged something like this into a branch for improving the
manual that I hope to commit to CVS sometime soon (this month, rather
than this year :-)

> The only oddity I can see in the patch file is that when I ran the emacs
> texinfo mode command to update every node, it added previous and next
> links to nodes in the debugging texinfo file that didn't have them.  As
> far as I can tell, those links are correctly computed, so I left them in.
>
> I'm not entirely sure of the patch submission procedure.  Please let me
> know if this one is not prepared properly, and I will try to fix it.

Well, ideally not having a whole bunch of noise in the patch would have
been good -- I know emacs put them there, and I know that they were
"right", but they still made it hard to see what you were actually
adding.

Other than that, the patch was fine; I played a bit with git attributes
yesterday, though, and decided that the following was cute:

in ~/.gitattributes or .git/info/attributes

  *.lisp diff=lisp
  *.texinfo diff=texinfo

in ~/.gitconfig or .git/config

  [diff "lisp"]
        xfuncname="^(\\(def.*)$"
  [diff "texinfo"]
        xfuncname="^(@(sub)*section.*)$"

I am but a git novice; I'm sure that there are other people on this list
with extensive customizations for patch prettiness.

Cheers,

Christophe