No docstring slot for pcase--make-docstring

No docstring slot for pcase--make-docstring

[martin rudalics]

When building master I currently see

Finding pointers to doc strings...
No docstring slot for pcase--make-docstring
Finding pointers to doc strings...done

Is this something I should care about?

Thanks in advance for enlightenment, martin

Re: No docstring slot for pcase--make-docstring

[Michael Heerdegen]

martin rudalics <rudalics@gmx.at> writes:

> When building master I currently see
>
> Finding pointers to doc strings...
> No docstring slot for pcase--make-docstring
> Finding pointers to doc strings...done
>
> Is this something I should care about?

Stefan (CC'd) had added autoload cookies to achieve that C-h f pcase
looks sane when pcase.el had not yet been loaded.  pcase--make-docstring
is now autoloaded, but it's an internal helper and don't has, and
probably don't needs, a docstring.  Yet Emacs complains because it's
autoloaded.

Is something like

(put 'pcase 'function-documentation
     '(progn (require 'pcase) (pcase--make-docstring)))

an alternative to autoloading `pcase--make-docstring'?

Michael.

Re: No docstring slot for pcase--make-docstring

[Stefan Monnier]

>> Finding pointers to doc strings...
>> No docstring slot for pcase--make-docstring
>> Finding pointers to doc strings...done

I wonder why we get this message.  AFAICT this message comes from
Snarf-documentation, but since pcase--make-docstring doesn't have
a docstring, it shouldn't appear in etc/DOC and hence shouldn't be
touched by Snarf-documentation.

...Oh, I see that the autoload does have a "dummy" docstring providing
the name of the arguments (tho here there are none, so it's really
silly) and for that reason pcase--make-docstring does appear in etc/DOC.

> (put 'pcase 'function-documentation
>      '(progn (require 'pcase) (pcase--make-docstring)))

The warning is definitely harmless here (especially since AFAICT it only
appears when dumping `bootstrap-emacs` and not for the real `emacs`), so
this is not needed.  Maybe we should fix the autoload to not have
a docstring, OTOH?  Or maybe we shouldn't bother to Snarf-documentation
for bootstrap-emacs?


        Stefan

Re: No docstring slot for pcase--make-docstring

[Stefan Monnier]

>> When building master I currently see
>>
>> Finding pointers to doc strings...
>> No docstring slot for pcase--make-docstring
>> Finding pointers to doc strings...done
>>
>> Is this something I should care about?

I believe this should be fixed now.


        Stefan

Re: No docstring slot for pcase--make-docstring

[martin rudalics]

 >>> Finding pointers to doc strings...
 >>> No docstring slot for pcase--make-docstring
 >>> Finding pointers to doc strings...done
 >>>
 >>> Is this something I should care about?
 >
 > I believe this should be fixed now.

It's still here after today's checkout.

martin

Re: No docstring slot for pcase--make-docstring

[martin rudalics]

> It's still here after today's checkout.

But apparently it disappeared after recompiling autoload.el.  So it
seems to be fixed indeed.

Many thanks, martin

Re: No docstring slot for pcase--make-docstring

[martin rudalics]

And it's here again.

Finding pointers to doc strings...
No docstring slot for pcase--make-docstring
Finding pointers to doc strings...done
Dumping under the name bootstrap-emacs.pdmp
dumping fingerprint: 62cb4fea729e5e096e667c1459564f7db0b4edba8329453a8ed0478dcc49389c
Dump complete

 From my latest build of master.

martin, confused

Re: No docstring slot for pcase--make-docstring

[Eli Zaretskii]

> Date: Sat, 09 Mar 2019 10:46:20 +0100
> From: martin rudalics <rudalics@gmx.at>
> Cc: emacs-devel <emacs-devel@gnu.org>
> 
> And it's here again.
> 
> Finding pointers to doc strings...
> No docstring slot for pcase--make-docstring
> Finding pointers to doc strings...done
> Dumping under the name bootstrap-emacs.pdmp
> dumping fingerprint: 62cb4fea729e5e096e667c1459564f7db0b4edba8329453a8ed0478dcc49389c
> Dump complete
> 
>  From my latest build of master.

Doesn't happen to me, FWIW.

Re: No docstring slot for pcase--make-docstring

[martin rudalics]

 > Doesn't happen to me, FWIW.

Reliably reproducible so far here.

martin

Re: No docstring slot for pcase--make-docstring

[Stefan Monnier]

>> Doesn't happen to me, FWIW.
> Reliably reproducible so far here.

Even after a full bootstrap?
In order for the fix to "take effect" you need (in order of appearance):
- recompile autoload.el.
- either modify pcase.el or remove loaddefs.el to rebuild it
  from scratch.
- make autoloads


        Stefan

Re: No docstring slot for pcase--make-docstring

[martin rudalics]

 >> Reliably reproducible so far here.
 >
 > Even after a full bootstrap?

I did not try that.

 > In order for the fix to "take effect" you need (in order of appearance):
 > - recompile autoload.el.
 > - either modify pcase.el or remove loaddefs.el to rebuild it
 >    from scratch.

It seems that recompiling pcase.el indeed helps.

 > - make autoloads

I forgot in which directory to do that.  So far it only tells
me make: *** No rule to make target `autoloads'.  Stop.

Thanks, martin

Re: No docstring slot for pcase--make-docstring

[Stefan Monnier]

>> Even after a full bootstrap?
> I did not try that.

Can't blame you: I didn't either.

>> In order for the fix to "take effect" you need (in order of appearance):
>> - recompile autoload.el.
>> - either modify pcase.el or remove loaddefs.el to rebuild it
>>    from scratch.
> It seems that recompiling pcase.el indeed helps.

I think changing the modtime of pcase.el is what it takes (so that "make
autoloads" reconsults pcase.el).

>> - make autoloads
> I forgot in which directory to do that.  So far it only tells
> me make: *** No rule to make target `autoloads'.  Stop.

(cd lisp; make autoloads)


        Stefan

Re: No docstring slot for pcase--make-docstring

[martin rudalics]

 > (cd lisp; make autoloads)

In the lisp source directory apparently.  That reruns configure here,
wants my standard compiler options and bows out with an error when it
doesn't find all libraries.  Unusable so far here.

martin

Re: No docstring slot for pcase--make-docstring

[Noam Postavsky]

On Mon, 11 Mar 2019 at 05:33, martin rudalics <rudalics@gmx.at> wrote:
>
>  > (cd lisp; make autoloads)
>
> In the lisp source directory apparently.  That reruns configure here,
> wants my standard compiler options and bows out with an error when it
> doesn't find all libraries.  Unusable so far here.

If you're building out-of-tree, that should be lisp/ of the build directory.

Re: No docstring slot for pcase--make-docstring

[martin rudalics]

 >>   > (cd lisp; make autoloads)
 >>
 >> In the lisp source directory apparently.  That reruns configure here,
 >> wants my standard compiler options and bows out with an error when it
 >> doesn't find all libraries.  Unusable so far here.
 >
 > If you're building out-of-tree, that should be lisp/ of the build directory.

I see.  Logical but slightly confusing because the file is recreated
in the lisp/ of the source directory.

Thanks, martin