Mercurial > vim
view CONTRIBUTING.md @ 33060:897f3ed27be2 v9.0.1818
patch 9.0.1818: dynamically linking perl is broken
Commit: https://github.com/vim/vim/commit/55460da26c2756ec057c03c7d8641eda861bfcd2
Author: Christian Brabandt <cb@256bit.org>
Date: Tue Aug 29 21:31:28 2023 +0200
patch 9.0.1818: dynamically linking perl is broken
Problem: dynamically linking perl is broken
Solution: Fix all issues
This is a combination of several commits:
1) Fix if_perl.xs not being able to build on all versions of Perl (5.30)
This fixes the dynamic builds of Perl interface. The Perl interface file
previously had to manually copy and paste misc inline functions verbatim
from the Perl headers, because we defined `PERL_NO_INLINE_FUNCTIONS`
which prevents us form getting some function definitions. The original
reason we defined it was because those inline functions would reference
Perl functions that would cause linkage errors.
This is a little fragile as every time a new version of Perl comes out,
we inevitably have to copy over new versions of inline functions to our
file, and it's also easy to miss updates to existing functions.
Instead, remove the `PERL_NO_INLINE_FUNCTIONS` define, remove the manual
copy-pasted inline functions. Simply add stub implementations of the
missing linked functions like `Perl_sv_free2` and forward them to the
DLL version of the function at runtime. There are only a few functions
that need this treatment, and it's a simple stub so there is very low
upkeep compared to copying whole implementations to the file.
Also, fix the configure script so that if we are using dynamic linkage,
we don't pass `-lperl` to the build flags, to avoid accidental external
linkage while using dynamic builds. This is similar to how Python
integration works.
2) Fix GIMME_V deprecation warnings in Perl 5.38
Just use GIMME_V, and only use GIMME when using 5.30 to avoid needing to
link Perl_block_gimme. We could provide a stub like the other linked
functions like Perl_sv_free2, but simply using GIMME is the simplest and
it has always worked before.
3) Fix Perl 5.38 issues
Fix two issues:
3.1. Perl 5.38 links against more functions in their inline headers, so we
need to stub them too.
3.2. Perl 5.38 made Perl_get_context an inline function, but *only* for
non-Windows build. Fix that. Note that this was happening in Vim
currently, as it would build, but fail to run Perl code at runtime.
4) Fix Perl 5.36/5.38 when thread local is used
Perl 5.36 introduced using `_Thread_local` for the current context,
which causes inline functions to fail. Create a stub
`PL_current_context` thread local variable to satisfy the linker for
inlined functions. Note that this is going to result in a different
`PL_current_context` being used than the one used in the library, but so
far from testing it seems to work.
5) Add docs for how to build Perl for dynamic linking to work
closes: #12827
closes: #12914
Signed-off-by: Christian Brabandt <cb@256bit.org>
Co-authored-by: Yee Cheng Chin <ychin.git@gmail.com>
| author | Christian Brabandt <cb@256bit.org> |
|---|---|
| date | Tue, 29 Aug 2023 22:15:03 +0200 |
| parents | 34c1f4cd0c18 |
| children | c97e9e2d79a4 |
line wrap: on
line source
# Contributing to Vim Patches are welcome in whatever form. Discussions about patches happen on the vim-dev maillist. If you create a pull request on GitHub it will be forwarded to the vim-dev maillist. You can also send your patch there directly. In that case an attachment with a unified diff format is preferred. Information about the maillist can be found [on the Vim website]. [on the Vim website]: http://www.vim.org/maillist.php#vim-dev A pull request has the advantage that it will trigger the Continuous Integration tests, you will be warned of problems (you can ignore the coverage warning, it's noisy). Please consider adding a test. All new functionality should be tested and bug fixes should be tested for regressions: the test should fail before the fix and pass after the fix. Look through recent patches for examples and find help with ":help testing". The tests are located under "src/testdir". Contributions will be distributed with Vim under the Vim license. Providing a change to be included implies that you agree with this and your contribution does not cause us trouble with trademarks or patents. There is no CLA to sign. # Reporting issues We use GitHub issues, but that is not a requirement. Writing to the Vim maillist is also fine. Please use the GitHub issues only for actual issues. If you are not 100% sure that your problem is a Vim issue, please first discuss this on the Vim user maillist. Try reproducing the problem without any of your plugins or settings: vim --clean If you report an issue, please describe exactly how to reproduce it. For example, don't say "insert some text" but say what you did exactly: "ahere is some text<Esc>". Ideally, the steps you list can be used to write a test to verify the problem is fixed. Feel free to report even the smallest problem, also typos in the documentation. You can find known issues in the todo file: ":help todo". Or open [the todo file] on GitHub to see the latest version. [the todo file]: https://github.com/vim/vim/blob/master/runtime/doc/todo.txt # Syntax, indent and other runtime files The latest version of these files can be obtained from the repository. They are usually not updated with numbered patches. If you find a problem with one of these files or have a suggestion for improvement, please first try to contact the maintainer directly. Look in the header of the file for the name and email address. The maintainer will take care of issues and send updates to Bram for distribution with Vim. If the maintainer does not respond, contact the vim-dev maillist. # Translations Translating messages and runtime files is very much appreciated! These things can be translated: * Messages in Vim, see [src/po/README.txt][1] Also used for the desktop icons. * Menus, see [runtime/lang/README.txt][2] * Vim tutor, see [runtime/tutor/README.txt][3] * Manual pages, see [runtime/doc/\*.1][4] for examples * Installer, see [nsis/lang/\*.nsi][5] for examples The help files can be translated and made available separately. See https://www.vim.org/translations.php for examples. [1]: https://github.com/vim/vim/blob/master/src/po/README.txt [2]: https://github.com/vim/vim/blob/master/runtime/lang/README.txt [3]: https://github.com/vim/vim/blob/master/runtime/tutor/README.txt [4]: https://github.com/vim/vim/blob/master/runtime/doc/vim.1 [5]: https://github.com/vim/vim/blob/master/nsis/lang/english.nsi