Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Add and fix pod in copyright codingstd tests #851

Closed
rurban opened this Issue Oct 1, 2012 · 4 comments

Comments

Projects
None yet
2 participants
Member

rurban commented Oct 1, 2012

There is no pod_source_files method in Parrot::Distribution.
There is no copyright check in t/codingstd/copyright.t for pod files.

This leads to the following todos:

t/codingstd/copyright.t ............. 1/3 
#   Failed test 'Copyright statement exists'
#   at t/codingstd/copyright.t line 95.
# No copyright statement found in 38 files:
# docs/book/draft/ch07_dynpmcs.pod
# docs/book/draft/appe_source_code.pod
# docs/book/draft/chXX_testing_and_debugging.pod
# docs/book/pct/ch02_getting_started.pod
# docs/book/pir/ch09_exceptions.pod
# docs/book/pir/ch02_getting_started.pod
# docs/book/pir/ch01_introduction.pod
# docs/book/draft/ch11_directive_reference.pod
# docs/book/draft/chXX_hlls.pod
# docs/book/draft/ch01_introduction.pod
# docs/book/pct/ch01_introduction.pod
# docs/book/draft/appb_patch_submission.pod
# README_win32.pod
# docs/book/draft/ch08_dynops.pod
# docs/book/draft/chXX_library.pod
# docs/book/pir/ch04_variables.pod
# docs/book/pir/ch06_subroutines.pod
# docs/book/draft/appd_build_options.pod
# docs/book/draft/appa_glossary.pod
# docs/book/draft/appc_command_line_options.pod
# docs/book/pir/ch08_io.pod
# docs/book/draft/ch10_opcode_reference.pod
# docs/book/draft/ch12_operator_reference.pod
# README_cygwin.pod
# docs/book/pct/ch04_pge.pod
# docs/book/pir/ch07_objects.pod
# docs/book/pct/ch03_compiler_tools.pod
# docs/book/pir/ch05_control_structures.pod
# docs/book/draft/ch02_getting_started.pod
# docs/book/pct/ch05_nqp.pod
# docs/book/pir/ch03_basic_syntax.pod
# docs/parrothist.pod
# t/tools/install/testlib/docs/compiler_faq.pod
# t/tools/install/testlib/docs/gettingstarted.pod
# t/tools/install/testlib/docs/pct/past_building_blocks.pod
# docs/pmc/subs.pod
# docs/project/git_terminology.pod
# src/dynpmc/README.pod

# The copyright statement should read something like:
#   Copyright (C) C<start-year>-C<last-year-modified>, Parrot Foundation.
# To find the C<start-year>, use a command such as:
#   git log C<filename> | grep '^Date' | tail -n 1
# To find the C<last-year-modified>, use a command such as:
#   git log C<filename> | grep '^Date' | head -n 1

#   Failed test 'Copyright statement in the right format'
#   at t/codingstd/copyright.t line 104.
# Bad format in copyright statement found in 8 files:
# docs/binaries/parrot_config.pod
# docs/pct/gettingstarted.pod
# docs/pdds/pdd10_embedding.pod
# docs/pdds/pdd26_ast.pod
# docs/project/support_policy.pod
# ext/winxed/README.pod
# lib/Pod/Simple.pod
# lib/Pod/Simple/Subclassing.pod

# Please update to read something like:
#   Copyright (C) C<start-year>-C<last-year-modified>, Parrot Foundation.
# To find the C<start-year>, use a command such as:
#   git log C<filename> | grep '^Date' | tail -n 1
# To find the C<last-year-modified>, use a command such as:
#   git log C<filename> | grep '^Date' | head -n 1

not ok 3 - Duplicate Copyright statements # TODO duplicate copyrights exist.
# Looks like you failed 2 tests of 3.

@rurban rurban was assigned Oct 1, 2012

@rurban rurban pushed a commit that referenced this issue Oct 1, 2012

Reini Urban [GH #851] Add pod_source_files to Parrot::Distribution and t/codingst…
…d/copyright.t

This leads to several errors in the copyright.t tests
e6cf9e5
Member

rurban commented Dec 28, 2012

Skip (C) tests for docs/book since these pods contain a README with a (C) statement for the book chapters.

Member

rurban commented Dec 28, 2012

Fixed with f175cd6, branch rurban/pod-copyright-gh851

One remaining test is failing, need a seperate ticket for ext/winxed/README.pod is (C) Julián Albo "NotFound"

Owner

leto commented Dec 29, 2012

We should not assert that files in ext/* are copyright Parrot Foundation, but rather, that they have some kind of copyright.

@rurban rurban pushed a commit that referenced this issue Jan 3, 2013

Reini Urban [GH #851] Add pod_source_files to Parrot::Distribution and t/codingst…
…d/copyright.t

This leads to several errors in the copyright.t tests
19e22a7

@rurban rurban pushed a commit that referenced this issue Jan 3, 2013

Reini Urban [codingstd][GH #851] Adapt copyright.t tests to POD files
skip book chapters since they contain an extra README.pod
skip empty t/tools/install/testlib/docs
skip bad_format test for bundled lib/Pod/*.pod since they are (C) with same terms as Perl.
skip duplicate (C) tests in .pod as they usually have the header plus a COPYRIGHT paragraph
adfa0cd

@rurban rurban pushed a commit that referenced this issue Jan 3, 2013

Reini Urban [codingstd][GH #851] Add missing (C) lines to POD
Also update README_win32.pod content
6598ffc
Member

rurban commented Jan 3, 2013

Merged with d6dcaf3

@rurban rurban closed this Jan 3, 2013

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment