upstream/mercurial-mirror Files · contrib/fuzz/README.rst

releasenotes: add a file in which to record release notes...

releasenotes: add a file in which to record release notes I've just spent a few very boring hours going through the changelog for the 5.0 release (829 commits). We only had 5 commits that used the syntax that the release notes extension expects. This commit adds a file in which we can record important changes. The file should preferably be edited in the patch that makes the important change, but it can also be edited after (I think this is an important benefit compared to the release notes extension). I'm thinking that we can rename the file from "next" to "5.1" or something when it's time, and then we'd create a new "next" file on the default branch. I've used the syntax that we use on the our wiki in the template, but I don't care much that we use any valid syntax at all. The idea is mostly to record important changes when they happen. I expect that some copy editing will be needed at release time anyway. Differential Revision: https://phab.mercurial-scm.org/D6332

Augie Fackler - - Load All Authors

File last commit:

r36716:e437de38 default


                r42457:0ed293a3

default

Download file

             README.rst
        
                    26 lines
            
             | 894 B
            
                | text/x-rst
            
             |
                RstLexer
            
             / contrib / fuzz / README.rst
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Augie Fackler
    
fuzz: add a quick README to try and document how to test new fuzzers...

              r36698
            
      How to add fuzzers (partially cribbed from oss-fuzz[0]):

        1) git clone https://github.com/google/oss-fuzz

        2) cd oss-fuzz

        3) python infra/helper.py build_image mercurial

        4) docker run --cap-add=SYS_PTRACE -it -v $HG_REPO_PATH:/hg-new \

               gcr.io/oss-fuzz/mercurial bash

        5) cd /src

        6) rm -r mercurial

        7) ln -s /hg-new mercurial

        8) cd mercurial

        9) compile

        Augie Fackler
    
fuzz: add some more docs about building/running fuzzers...

              r36716
            
        10) ls $OUT

      Step 9 is literally running the command "compile", which is part of

      the docker container. Once you have that working, you can build the

      fuzzers like this (in the oss-fuzz repo):

      python infra/helper.py build_fuzzers --sanitizer address mercurial $HG_REPO_PATH

      (you can also say "memory", "undefined" or "coverage" for

      sanitizer). Then run the built fuzzers like this:

      python infra/helper.py run_fuzzer mercurial -- $FUZZER

        Augie Fackler
    
fuzz: add a quick README to try and document how to test new fuzzers...

              r36698
            
      0: https://github.com/google/oss-fuzz/blob/master/docs/new_project_guide.md

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

Augie Fackler fuzz: add a quick README to try and document how to test new fuzzers...	r36698	How to add fuzzers (partially cribbed from oss-fuzz[0]):

		1) git clone https://github.com/google/oss-fuzz
		2) cd oss-fuzz
		3) python infra/helper.py build_image mercurial
		4) docker run --cap-add=SYS_PTRACE -it -v $HG_REPO_PATH:/hg-new \
		gcr.io/oss-fuzz/mercurial bash
		5) cd /src
		6) rm -r mercurial
		7) ln -s /hg-new mercurial
		8) cd mercurial
		9) compile
Augie Fackler fuzz: add some more docs about building/running fuzzers...	r36716	10) ls $OUT

		Step 9 is literally running the command "compile", which is part of
		the docker container. Once you have that working, you can build the
		fuzzers like this (in the oss-fuzz repo):

		python infra/helper.py build_fuzzers --sanitizer address mercurial $HG_REPO_PATH

		(you can also say "memory", "undefined" or "coverage" for
		sanitizer). Then run the built fuzzers like this:

		python infra/helper.py run_fuzzer mercurial -- $FUZZER
Augie Fackler fuzz: add a quick README to try and document how to test new fuzzers...	r36698
		0: https://github.com/google/oss-fuzz/blob/master/docs/new_project_guide.md