Skip to content
New issue

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

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add spm man page to setup.py #25213

Closed
aboe76 opened this issue Jul 7, 2015 · 13 comments
Closed

Add spm man page to setup.py #25213

aboe76 opened this issue Jul 7, 2015 · 13 comments
Labels
Bug broken, incorrect, or confusing behavior Documentation Relates to Salt documentation fixed-pls-verify fix is linked, bug author to confirm fix P3 Priority 3 severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around
Milestone

Comments

@aboe76
Copy link
Contributor

aboe76 commented Jul 7, 2015

spm doesn't have a man page yet.

@aboe76
Copy link
Contributor Author

aboe76 commented Jul 7, 2015

@techhat ping.

@techhat
Copy link
Contributor

techhat commented Jul 7, 2015

@aboe76 I'm under the understanding that #25072 should generate a man page.

@techhat
Copy link
Contributor

techhat commented Jul 7, 2015

@basepi, @cro, thoughts?

@aboe76
Copy link
Contributor Author

aboe76 commented Jul 7, 2015

@techhat , I build daily the develop branch of salt on my archlinux box, and didn't find a man page

@rallytime
Copy link
Contributor

@jacobhammons Might know about that as well. It might need to be generated still.

@jfindlay jfindlay added Documentation Relates to Salt documentation Bug broken, incorrect, or confusing behavior severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around P3 Priority 3 labels Jul 7, 2015
@jfindlay jfindlay added this to the Approved milestone Jul 7, 2015
@basepi
Copy link
Contributor

basepi commented Jul 7, 2015

Yeah, @jacobhammons only generates manpages every once in awhile, I think the last one was more than 7 days ago (which was before that pull request was merged)

@rallytime
Copy link
Contributor

@aboe76 This should be fixed from @jacobhammons's speedy response. Can you close this if the man pages are working for you now?

@aboe76
Copy link
Contributor Author

aboe76 commented Jul 8, 2015

almost fixed: setup.py also needs to be changed, to include the generated spm man page, in other to move it to the right place:

line 694,726 setup.py.

@property
    def _property_data_files(self):
        # Data files common to all scenarios
        data_files = [
            ('share/man/man1', ['doc/man/salt-call.1']),
            ('share/man/man7', ['doc/man/salt.7'])
        ]
        if self.ssh_packaging or PACKAGED_FOR_SALT_SSH:
            data_files[0][1].append('doc/man/salt-ssh.1')
            if IS_WINDOWS_PLATFORM:
                return data_files
            data_files[0][1].extend(['doc/man/salt-run.1',
                                     'doc/man/salt-cloud.1'])
            return data_files

        if IS_WINDOWS_PLATFORM:
            data_files[0][1].extend(['doc/man/salt-cp.1',
                                     'doc/man/salt-minion.1',
                                     'doc/man/salt-unity.1'])
            return data_files

        # *nix, so, we need all man pages
        data_files[0][1].extend(['doc/man/salt-api.1',
                                 'doc/man/salt-cloud.1',
                                 'doc/man/salt-cp.1',
                                 'doc/man/salt-key.1',
                                 'doc/man/salt-master.1',
                                 'doc/man/salt-minion.1',
                                 'doc/man/salt-run.1',
                                 'doc/man/salt-ssh.1',
                                 'doc/man/salt-syndic.1',
                                 'doc/man/salt-unity.1'])
        return data_files

@rallytime
Copy link
Contributor

ping @jacobhammons

jacobhammons added a commit to jacobhammons/salt that referenced this issue Jul 9, 2015
@aboe76
Copy link
Contributor Author

aboe76 commented Jul 9, 2015

I can validate this, with the latest development version the man page of spm is present:

copying doc/man/spm.1 -> /home/aboe/Development/packages/salt-git/pkg/salt-git/usr/share/man/man1

salt version: salt-2015.5.0_1721_ga3e209d

@rallytime make sure this gets backported into 2015.8 please

@aboe76
Copy link
Contributor Author

aboe76 commented Jul 14, 2015

@rallytime so I can close this issue?

@rallytime
Copy link
Contributor

Definitely!

@aboe76
Copy link
Contributor Author

aboe76 commented Jul 14, 2015

nice! :)

rallytime pushed a commit to rallytime/salt that referenced this issue Jul 20, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug broken, incorrect, or confusing behavior Documentation Relates to Salt documentation fixed-pls-verify fix is linked, bug author to confirm fix P3 Priority 3 severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around
Projects
None yet
Development

No branches or pull requests

5 participants