Skip to content

README.valgrind should mention --with-valgrind #63059

Closed

Description

@tim-one
BPO 18859
Nosy @tim-one, @ambv, @elenaoat, @CuriousLearner
PRs
  • bpo-18859: Document --with-valgrind option in README.valgrind #10591
  • Files
  • patch.diff: Patch
  • issue18859.diff
  • Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = 'https://github.com/ambv'
    closed_at = <Date 2018-11-20.11:12:05.530>
    created_at = <Date 2013-08-28.00:19:48.855>
    labels = ['easy', 'type-feature', '3.8', 'build']
    title = 'README.valgrind should mention --with-valgrind'
    updated_at = <Date 2018-11-20.11:12:05.518>
    user = 'https://github.com/tim-one'

    bugs.python.org fields:

    activity = <Date 2018-11-20.11:12:05.518>
    actor = 'lukasz.langa'
    assignee = 'lukasz.langa'
    closed = True
    closed_date = <Date 2018-11-20.11:12:05.530>
    closer = 'lukasz.langa'
    components = ['Build']
    creation = <Date 2013-08-28.00:19:48.855>
    creator = 'tim.peters'
    dependencies = []
    files = ['36209', '42147']
    hgrepos = []
    issue_num = 18859
    keywords = ['patch', 'easy']
    message_count = 9.0
    messages = ['196338', '196548', '224559', '224573', '261647', '294386', '330109', '330125', '330126']
    nosy_count = 7.0
    nosy_names = ['tim.peters', 'mmokrejs', 'lukasz.langa', 'Elena.Oat', 'sowmya-ravidas', 'CuriousLearner', 'Sourav Singh']
    pr_nums = ['10591']
    priority = 'normal'
    resolution = 'fixed'
    stage = 'resolved'
    status = 'closed'
    superseder = None
    type = 'enhancement'
    url = 'https://bugs.python.org/issue18859'
    versions = ['Python 3.8']

    Activity

    1. tim-one commented on Aug 28, 2013

      @tim-one
      MemberAuthor

      In bpo-18843 a user noted that Misc/README.valgrind doesn't mention the --with-valgrind configure option. It probably should. But since I've never used valgrind, I'm not the guy to do it ;-)

    2. mmokrejs commented on Aug 30, 2013

      mmokrejsmannequin
      Mannequin

      Moreover, it should explain what that really does. One could think of several answers or even their combinations what this configure flag will really do:

      a) python will run itself under valgrind, don't bother ever doing it yourself
      b) you don't have to bother with uncommenting the lines in valgrind.supp
      c) "make install" will install the valgrind.supp but you have to edit it on your own
      d) you may use valgrind but don't use other tool replacing malloc(), like electric fence, DUMA, etc. You should be quite verbose how (in)compatible is this with other tools.

      Or some combination of them?

      valgrind docs say it won't work if a binary lacks debug symbols (wasn't compiled with -g). Initially I got mislead I though I have to convert my blah.py to blah.c using cython, compile that with "gcc -ggdb blah.c" and then I may run valgrind on the binary.

      In the end, I don't understand why everybody has to remove the comment symbols from the valgrind-python.supp file at all. Why isn't that by default enabled?

      I also suggest you mention right in the file other handy information because people quite likely get on this path while chasing memory corruption issues, maybe broken hardware:

      1. Mention that python uses 256kB chunks by default.
      2. Mention there exists --without-pymalloc as Tim explained me in http://bugs.python.org/issue18843#msg196492
      3. Explain how to interpret those stacktraces one could get: http://bugs.python.org/issue18843#msg196481

      Thank you!

    3. sowmya-ravidas commented on Aug 2, 2014

      sowmya-ravidasmannequin
      Mannequin

      Hi,

      I have created a patch for this bug.
      The Misc/README.valgrind now mentions the --with-valgrind configure options.

    4. skrah commented on Aug 2, 2014

      skrahmannequin
      Mannequin

      Hi Sowmya. Currently we have the option to use --with-valgrind or
      the old method --without-pymalloc. Both methods work.

    5. elenaoat commented on Mar 12, 2016

      elenaoatmannequin
      Mannequin

      I've combined the patch submitted by Sowmya and also added there clarifications from points 1, 2 mentioned by Martin Mokrejs.

    6. self-assigned this
      on Feb 3, 2017
    7. SouravSingh commented on May 24, 2017

      SouravSinghmannequin
      Mannequin

      Is the issue fixed?

    8. CuriousLearner commented on Nov 19, 2018

      @CuriousLearner
      Member

      Patch added in PR: #10591

    9. ambv commented on Nov 20, 2018

      @ambv
      Contributor

      New changeset d5d3368 by Łukasz Langa (Sanyam Khurana) in branch 'master':
      bpo-18859: Document --with-valgrind option in README.valgrind (bpo-10591)
      d5d3368

    10. ambv commented on Nov 20, 2018

      @ambv
      Contributor

      Thanks! ✨ 🍰 ✨

    11. transferred this issue fromon Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Metadata

    Metadata

    Assignees

    Labels

    3.8 (EOL)end of lifebuildThe build process and cross-buildeasytype-featureA feature request or enhancement

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions