Comments (12)
Hello! In pull request #148 is a fix for this problem. README.pod will be now installed as lib/DBD/MariaDB/README.pod file. Similarly autogenerated manpage.
README.pod in top level directory on github is a starting point and provides details about project. Bugs in ExtUtils::MakeMakers should not be reason to stop providing useful files.
from dbd-mariadb.
Could you please check that pull request if it fixes that problem?
from dbd-mariadb.
I thought that the README.pod was intended for the github repo, not as documentation. If you want to make it a documentation readme, it should include:
=head1 NAME
DBD::MariaDB::README - ...
from dbd-mariadb.
And also it should be stored in lib/DBD/MariaDB/README.pod, thus not needing this workaround.
from dbd-mariadb.
My suggestion was simply to not include it in the CPAN distribution, leaving it for github, using e.g. MANIFEST.SKIP.
from dbd-mariadb.
Is there any problem to have README file also in distribution on CPAN? I guess that downstream packagers for different Linux distribution would like to see some simple README file in released tarball.
Storing README file in different directory (like lib/DBD/MariaDB as you suggested) would not work. All software store README file in released tarball in top level directory. Nobody would be trying to find main README file deeply in some third level subdirectory.
from dbd-mariadb.
@pali Note: There is README file in my distributions. But in form of text, not POD. I think you can add creating of README from README.pod and README.pod skip in distribution.
from dbd-mariadb.
Is there any problem to have README file also in distribution on CPAN? I guess that downstream packagers for different Linux distribution would like to see some simple README file in released tarball.
Yes, README.pod specifically is subject to the ExtUtils::MakeMaker bug and cannot be included at the top level.
Storing README file in different directory (like lib/DBD/MariaDB as you suggested) would not work. All software store README file in released tarball in top level directory. Nobody would be trying to find main README file deeply in some third level subdirectory.
You are proposing to install it to DBD::MariaDB::README, so it should be stored at that location in the release, and also have the appropriate NAME section so metacpan displays it as documentation.
from dbd-mariadb.
Yes, README.pod specifically is subject to the ExtUtils::MakeMaker bug and cannot be included at the top level.
It should not be affected after applying #148 change.
from dbd-mariadb.
I guess my question is: what is the purpose of this readme? If it is for github, as I originally thought, then it only needs to be added to MANIFEST.SKIP. If it is documentation, then it should be moved to the correct location in lib/ and allowed to be shown on metacpan. If it is for github and the released tarball, but not as documentation, then it should not be installed.
from dbd-mariadb.
It is top level README file like in any other software distributed in tarball and visible by as main page on github. Therefore it cannot be in subdirectory and cannot be in MANIFEST.SKIP (as it would not be included in release tarball).
from dbd-mariadb.
I think the proposed solution is acceptable, if maybe not standard. It's unfortunate that we can't specify "use the general rules, but handle these particular files differently" - currently, one either uses the general rules, or has to specify the install location for each file manually.
from dbd-mariadb.
Related Issues (20)
- mariadb_st_finish() does not check mariadb_db_async_result() failure
- Add a missing break to 'MYSQL_TYPE_NULL' case in mariadb_st_describe()
- Test failures with MariaDB-10.6.4 + libmariadb3-3.2.3 HOT 9
- BUG? Can't find 'boot_DBD__MariaDB' in Windows/StrawberryPerl using distro DBD::MariaDB HOT 1
- MySQL server has gone away HOT 1
- t/40server_prepare.t fails HOT 3
- DBD-MariaDB-1.22: Build warnings HOT 5
- SIGPIPE ignored, resulting in: "Unable to flush stdout: Broken pipe" HOT 5
- `mariadb_use_result` is broken HOT 13
- BLOB as parameter in execute HOT 2
- As of MySQL 8.0.34 and 8.1.0 's libmysqlclients deprecates MYSQL_OPT_RECONNECT HOT 2
- Replace compile time version detection by runtime version detection
- Test MariaDB 10.5+ and MySQL 8.1+ server versions in Github Actions CI HOT 1
- failed: SSL connection error: Enforcing SSL encryption is not supported HOT 2
- DBD-MariaDB does not check "Active" on database handles when preparing / executing HOT 2
- Passing credentials via options file fails to read password (mariadb_read_default_file) HOT 3
- Options to the driver mysql_enable_utf8mb4 and mysql_enable_utf8 are not recognised HOT 5
- DBD::MariaDB 1.23 not updating cardinality in MariaDB 10.6.5 HOT 2
- Wrong enum value on insert/update if colum name contains string "limit"
- Version 1.23 92ssl_connection.t fails in openSUSE Build Service HOT 7
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from dbd-mariadb.