• Show log

    Commit

  • Hash : 7f5b8f19
    Author : Faraz Vahedi
    Date : 2023-11-18T15:55:14

    Fix documentation inconsistency in evhttp callbacks
    
    This commit addresses a minor inconsistency identified in the
    documentation of multiple `evhttp` callback functions within
    the `event2/http.h` header file. It was observed that the word
    "additional" was presumably missing in the description of the
    `arg` parameter for several functions. This oversight led to
    an incorrect phrasing: "an context argument for the callback."
    
    The documentation for the following functions has been updated
    to rectify this issue:
    
      - `evhttp_set_gencb`
      - `evhttp_set_bevcb`
      - `evhttp_set_newreqcb`
      - `evhttp_set_errorcb`
    
    This commit solely improves the readability of the function
    descriptions without altering any functional aspects of the
    code.
    

  • README.md

  • libevent logo

    CI Coverage Status Join the chat at https://gitter.im/libevent/libevent doxygen OpenSSF Scorecard

    1. BUILDING AND INSTALLATION

    CMake (Unix)

    mkdir build && cd build
    cmake ..     # Default to Unix Makefiles.
    make
    make verify  # (optional)

    See Documentation/Building#Building on Unix using CMake for more information.

    CMake (Windows)

    Install CMake: https://cmake.org/

    md build && cd build
    cmake -G "Visual Studio 10" ..   # Or use any generator you want to use. Run cmake --help for a list
    cmake --build . --config Release # Or "start libevent.sln" and build with menu in Visual Studio.

    See Documentation/Building#Building on Windows for more information.

    Package Managers

    You can download and install libevent using the vcpkg dependency manager:

    git clone https://github.com/Microsoft/vcpkg.git
    cd vcpkg
    ./bootstrap-vcpkg.sh
    ./vcpkg integrate install
    ./vcpkg install libevent

    The libevent port in vcpkg is kept up to date by Microsoft team members and community contributors. If the version is out of date, please create an issue or pull request on the vcpkg repository.

    Autoconf

    Note, since 2.2 it is deprecated

    ./configure
    make
    make verify   # (optional)
    sudo make install

    See Documentation/Building#Autoconf for more information.

    2. USEFUL LINKS:

    For the latest released version of Libevent, see the official website at https://libevent.org/ .

    There’s a pretty good work-in-progress manual up at http://www.wangafu.net/~nickm/libevent-book/ .

    For the latest development versions of Libevent, access our Git repository via

    $ git clone https://github.com/libevent/libevent.git

    You can browse the git repository online at:

    https://github.com/libevent/libevent

    To report bugs, issues, or ask for new features:

    Patches: https://github.com/libevent/libevent/pulls

    OK, those are not really patches. You fork, modify, and hit the “Create Pull Request” button. You can still submit normal git patches via the mailing list.

    Bugs, Features [RFC], and Issues: https://github.com/libevent/libevent/issues

    Or you can do it via the mailing list.

    There’s also a libevent-users mailing list for talking about Libevent use and development:

    https://archives.seul.org/libevent/users/

    3. ACKNOWLEDGMENTS

    The following people have helped with suggestions, ideas, code or fixing bugs.