{ "content": [ { "type": "text", "text": "# Dist::CheckConflicts (perldoc)\n\n## NAME\n\nDist::CheckConflicts - declare version conflicts for your dist\n\n## SYNOPSIS\n\nuse Dist::CheckConflicts\n-dist => 'Class-MOP',\n-conflicts => {\n'Moose' => '1.14',\n'namespace::autoclean' => '0.08',\n},\n-also => [\n'Package::Stash::Conflicts',\n];\nPACKAGE->checkconflicts;\n\n## DESCRIPTION\n\nOne shortcoming of the CPAN clients that currently exist is that they have no way of specifying\nconflicting downstream dependencies of modules. This module attempts to work around this issue\nby allowing you to specify conflicting versions of modules separately, and deal with them after\nthe module is done installing.\n\n## Sections\n\n- **NAME**\n- **VERSION**\n- **SYNOPSIS**\n- **DESCRIPTION** (3 subsections)\n- **METHODS**\n- **BUGS**\n- **SEE ALSO**\n- **SUPPORT**\n- **AUTHOR**\n- **COPYRIGHT AND LICENSE**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "Dist::CheckConflicts", "section": "", "mode": "perldoc", "summary": "Dist::CheckConflicts - declare version conflicts for your dist", "synopsis": "use Dist::CheckConflicts\n-dist => 'Class-MOP',\n-conflicts => {\n'Moose' => '1.14',\n'namespace::autoclean' => '0.08',\n},\n-also => [\n'Package::Stash::Conflicts',\n];\nPACKAGE->checkconflicts;", "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [ { "flag": "", "long": null, "arg": null, "description": "A hashref of conflict specifications, where keys are module names, and values are the last broken version - any version greater than the specified version should work." }, { "flag": "", "long": null, "arg": null, "description": "Additional modules to get conflicts from (potentially recursively). This should generally be a list of modules which use Dist::CheckConflicts, which correspond to the dists that your dist depends on. (In an ideal world, this would be intuited directly from your dependency list, but the dependency list isn't available outside of build time)." }, { "flag": "", "long": null, "arg": null, "description": "The name of the distribution, to make the error message from checkconflicts more user-friendly. The methods listed below are exported by this module into the module that uses it, so you should call these methods on your module, not Dist::CheckConflicts. As an example, this command line can be used to update your modules, after installing the \"Foo\" dist (assuming that \"Foo::Conflicts\" is the module in the \"Foo\" dist which uses Dist::CheckConflicts): perl -MFoo::Conflicts -e'print \"$\\n\" for map { $->{package} } Foo::Conflicts->calculateconflicts' | cpanm As an added bonus, loading your conflicts module will provide warnings at runtime if conflicting modules are detected (regardless of whether they are loaded before or afterwards)." } ], "examples": [], "see_also": [], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "VERSION", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 12, "subsections": [] }, { "name": "DESCRIPTION", "lines": 17, "subsections": [ { "name": "-conflicts", "lines": 3 }, { "name": "-also", "lines": 5 }, { "name": "-dist", "lines": 16 } ] }, { "name": "METHODS", "lines": 16, "subsections": [] }, { "name": "BUGS", "lines": 4, "subsections": [] }, { "name": "SEE ALSO", "lines": 4, "subsections": [] }, { "name": "SUPPORT", "lines": 22, "subsections": [] }, { "name": "AUTHOR", "lines": 2, "subsections": [] }, { "name": "COPYRIGHT AND LICENSE", "lines": 5, "subsections": [] } ], "sections": { "NAME": { "content": "Dist::CheckConflicts - declare version conflicts for your dist\n", "subsections": [] }, "VERSION": { "content": "version 0.11\n", "subsections": [] }, "SYNOPSIS": { "content": "use Dist::CheckConflicts\n-dist => 'Class-MOP',\n-conflicts => {\n'Moose' => '1.14',\n'namespace::autoclean' => '0.08',\n},\n-also => [\n'Package::Stash::Conflicts',\n];\n\nPACKAGE->checkconflicts;\n", "subsections": [] }, "DESCRIPTION": { "content": "One shortcoming of the CPAN clients that currently exist is that they have no way of specifying\nconflicting downstream dependencies of modules. This module attempts to work around this issue\nby allowing you to specify conflicting versions of modules separately, and deal with them after\nthe module is done installing.\n\nFor instance, say you have a module \"Foo\", and some other module \"Bar\" uses \"Foo\". If \"Foo\" were\nto change its API in a non-backwards-compatible way, this would cause \"Bar\" to break until it is\nupdated to use the new API. \"Foo\" can't just depend on the fixed version of \"Bar\", because this\nwill cause a circular dependency (because \"Bar\" is already depending on \"Foo\"), and this doesn't\nexpress intent properly anyway - \"Foo\" doesn't use \"Bar\" at all. The ideal solution would be for\nthere to be a way to specify conflicting versions of modules in a way that would let CPAN\nclients update conflicting modules automatically after an existing module is upgraded, but until\nthat happens, this module will allow users to do this manually.\n\nThis module accepts a hash of options passed to its \"use\" statement, with these keys being\nvalid:\n", "subsections": [ { "name": "-conflicts", "content": "A hashref of conflict specifications, where keys are module names, and values are the last\nbroken version - any version greater than the specified version should work.\n" }, { "name": "-also", "content": "Additional modules to get conflicts from (potentially recursively). This should generally be\na list of modules which use Dist::CheckConflicts, which correspond to the dists that your\ndist depends on. (In an ideal world, this would be intuited directly from your dependency\nlist, but the dependency list isn't available outside of build time).\n" }, { "name": "-dist", "content": "The name of the distribution, to make the error message from checkconflicts more\nuser-friendly.\n\nThe methods listed below are exported by this module into the module that uses it, so you should\ncall these methods on your module, not Dist::CheckConflicts.\n\nAs an example, this command line can be used to update your modules, after installing the \"Foo\"\ndist (assuming that \"Foo::Conflicts\" is the module in the \"Foo\" dist which uses\nDist::CheckConflicts):\n\nperl -MFoo::Conflicts -e'print \"$\\n\"\nfor map { $->{package} } Foo::Conflicts->calculateconflicts' | cpanm\n\nAs an added bonus, loading your conflicts module will provide warnings at runtime if conflicting\nmodules are detected (regardless of whether they are loaded before or afterwards).\n" } ] }, "METHODS": { "content": "conflicts\nReturns the conflict specification (the \"-conflicts\" parameter to \"import()\"), as a hash.\n\ndist\nReturns the dist name (either as specified by the \"-dist\" parameter to \"import()\", or the\npackage name which \"use\"d this module).\n\ncheckconflicts\nExamine the modules that are currently installed, and throw an exception with useful information\nif any modules are at versions which conflict with the dist.\n\ncalculateconflicts\nExamine the modules that are currently installed, and return a list of modules which conflict\nwith the dist. The modules will be returned as a list of hashrefs, each containing \"package\",\n\"installed\", and \"required\" keys.\n", "subsections": [] }, "BUGS": { "content": "No known bugs.\n\nPlease report any bugs to GitHub Issues at .\n", "subsections": [] }, "SEE ALSO": { "content": "Module::Install::CheckConflicts\n\nDist::Zilla::Plugin::Conflicts\n", "subsections": [] }, "SUPPORT": { "content": "You can find this documentation for this module with the perldoc command.\n\nperldoc Dist::CheckConflicts\n\nYou can also look for information at:\n\n* MetaCPAN\n\n\n\n* Github\n\n\n\n* RT: CPAN's request tracker\n\n\n\n* CPAN Ratings\n\n\n", "subsections": [] }, "AUTHOR": { "content": "Jesse Luehrs \n", "subsections": [] }, "COPYRIGHT AND LICENSE": { "content": "This software is copyright (c) 2014 by Jesse Luehrs.\n\nThis is free software; you can redistribute it and/or modify it under the same terms as the Perl\n5 programming language system itself.\n", "subsections": [] } } } }