Skip to content
This repository has been archived by the owner on Jan 31, 2022. It is now read-only.

yum info prints the total content of README #221

Open
1 of 2 tasks
mexanick opened this issue Feb 15, 2019 · 1 comment
Open
1 of 2 tasks

yum info prints the total content of README #221

mexanick opened this issue Feb 15, 2019 · 1 comment

Comments

@mexanick
Copy link
Contributor

Brief summary of issue

When running yum info on this package it prints all what's in the README.md including special characters used for markdown, which is very inconvenient

Types of issue

  • Bug report (report an issue with the code)
  • Feature request (request for change which adds functionality)

Expected Behavior

Should print the simple description of the package

Current Behavior

yum info command outputs:

Name        : gempython_vfatqc
Arch        : x86_64
Version     : 2.4.1
Release     : centos7.python2.7
Size        : 99 k
Repo        : gemos-updates
Summary     : None
URL         : https://cms-gem-daq-project.github.io/vfatqc-python-tools
License     : MIT
Description :
            :
            : Branch|[Travis
            : CI](https://travis-ci.org)|[Coveralls](https://www.coveralls.io)|[Codecov](https://www.codecov.io)|[Codacy](https://www.codacy.com)|[Landscape](https://www.landscape.io)|[CodeClimate](https://www.codeclimate.com)
            : ---|---|---|---|---|---|--- master|[![Build
            : Status](https://travis-ci.org/cms-gem-daq-project/vfatqc-python-scripts.svg?branch=master)](https://travis-ci.org/travis-ci.org/cms-gem-daq-project/vfatqc-python-scripts)|[![Coveralls
            : Status](https://coveralls.io/repos/github/cms-gem-daq-project/vfatqc-python-scripts/badge.svg?branch=master)](https://coveralls.io/github/cms-gem-daq-project/vfatqc-python-scripts?branch=master)|[![codecov](https://codecov.io/gh/cms-gem-daq-project/vfatqc-python-scripts/branch/master/graph/badge.svg)](https://codecov.io/gh/cms-gem-daq-project/vfatqc-python-scripts)|[![Codacy
            : Badge](https://api.codacy.com/project/badge/Grade/00f0de54bcc94812b553ebeab74e9320)](https://www.codacy.com/app/cms-gem-daq-project/vfatqc-python-scripts?utm_source=github.com&utm_medium=referral&utm_content=cms-gem-daq-project/vfatqc-python-scripts&utm_campaign=Badge_Grade)|[![Landscape
            : Status](https://landscape.io/github/cms-gem-daq-project/vfatqc-python-scripts/master/landscape.svg)](https://landscape.io/github/cms-gem-daq-project/vfatqc-python-scripts/master)|[![Code
            : Climate](https://codeclimate.com/github/cms-gem-daq-project/vfatqc-python-scripts/badges/gpa.svg)](https://codeclimate.com/github/cms-gem-daq-project/vfatqc-python-scripts)
            : develop|[![Build
            : Status](https://travis-ci.org/cms-gem-daq-project/vfatqc-python-scripts.svg?branch=develop)](https://travis-ci.org/travis-ci.org/cms-gem-daq-project/vfatqc-python-scripts)|[![Coveralls
            : Status](https://coveralls.io/repos/github/cms-gem-daq-project/vfatqc-python-scripts/badge.svg?branch=develop)](https://coveralls.io/github/cms-gem-daq-project/vfatqc-python-scripts?branch=develop)|[![codecov](https://codecov.io/gh/cms-gem-daq-project/vfatqc-python-scripts/branch/develop/graph/badge.svg)](https://codecov.io/gh/cms-gem-daq-project/vfatqc-python-scripts)|[![Codacy
            : Badge](https://api.codacy.com/project/badge/Grade/00f0de54bcc94812b553ebeab74e9320)](https://www.codacy.com/app/cms-gem-daq-project/vfatqc-python-scripts?utm_source=github.com&utm_medium=referral&utm_content=cms-gem-daq-project/vfatqc-python-scripts&utm_campaign=Badge_Grade)|[![Landscape
            : Status](https://landscape.io/github/cms-gem-daq-project/vfatqc-python-scripts/develop/landscape.svg)](https://landscape.io/github/cms-gem-daq-project/vfatqc-python-scripts/develop)|[![Code
            : Climate](https://codeclimate.com/github/cms-gem-daq-project/vfatqc-python-scripts/badges/issue_count.svg)](https://codeclimate.com/github/cms-gem-daq-project/vfatqc-python-scripts)
            :
            :
            : 1. Setup:
            :
            :     The following `$SHELL` variables should be defined:
            :
            :     - $BUILD_HOME
            :     - $DATA_PATH
            :
            :     Then execute:
            :
            :     `source $BUILD_HOME/vfatqc-python-scripts/setup/paths.sh`
            :
            : 2. Running Scans:
            :
            :     See extensive documentation written at:
            :
            :     [GEM DOC Twiki Page](https://twiki.cern.ch/twiki/bin/viewauth/CMS/GEMDOCDoc#How_to_Run_Scans)
            :
            : 3. Contributing
            :
            :     See guidelines included in
            :     [CONTRIBUTING.md](https://github.com/cms-gem-daq-project/vfatqc-python-scripts/blob/master/.github/CONTRIBUTING.md)
            :
            : [travisci-svg]: https://cdn.svgporn.com/logos/travis-ci.svg
            : [coveralls-svg]: https://cdn.svgporn.com/logos/coveralls.svg
            : [codecov-svg]: https://cdn.svgporn.com/logos/codecov.svg
            : [codacy-svg]: https://cdn.svgporn.com/logos/
            : [landscapeio-svg]: https://cdn.svgporn.com/logos/
            : [codeclimate-svg]: https://cdn.svgporn.com/logos/codeclimate.svg

Steps to Reproduce (for bugs)

Run

yum info gempython-vfatqc*

Possible Solution (for bugs)

Replace the README.md with a shortened version containing only basic package description when building rpm.

Context (for feature requests)

Quick check of package version on the system is inconvenient

Your Environment

  • Version used: 2.4.1
  • Shell used: bash
@jsturdy
Copy link
Contributor

jsturdy commented Feb 15, 2019

Not technically a bug, but a "feature" (it was implemented this way by design)
But I agree that either the README should be simplified to a description, or a description should instead be used (also in cms-gem-daq-project/gem-plotting-tools#182)

AndrewLevin pushed a commit to AndrewLevin/vfatqc-python-scripts that referenced this issue May 19, 2020
…daq-project#221)

Fixes cms-gem-daq-project#219. The `vfatID` branch was added without removing it from the `crateMap`
creation.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants