OpenGrok
   HOME

TheInfoList



OR:

OpenGrok is a
source code In computing, source code, or simply code or source, is a plain text computer program written in a programming language. A programmer writes the human readable source code to control the behavior of a computer. Since a computer, at base, only ...
cross-reference The term cross-reference (abbreviation: xref) can refer to either: * An instance within a document which refers to related information elsewhere in the same document. In both printed and online dictionaries cross-references are important because ...
and
search engine A search engine is a software system that provides hyperlinks to web pages, and other relevant information on World Wide Web, the Web in response to a user's web query, query. The user enters a query in a web browser or a mobile app, and the sea ...
. It helps programmers search, cross-reference, and navigate source code trees to aid program comprehension. It can read program
file format A file format is a Computer standard, standard way that information is encoded for storage in a computer file. It specifies how bits are used to encode information in a digital storage medium. File formats may be either proprietary format, pr ...
s and
version control Version control (also known as revision control, source control, and source code management) is the software engineering practice of controlling, organizing, and tracking different versions in history of computer files; primarily source code t ...
histories such as Monotone,
Subversion Subversion () refers to a process by which the values and principles of a system in place are contradicted or reversed in an attempt to sabotage the established social order and its structures of Power (philosophy), power, authority, tradition, h ...
, Mercurial, Git, ClearCase, Perforce, AccuRev, Razor, and
Bazaar A bazaar or souk is a marketplace consisting of multiple small Market stall, stalls or shops, especially in the Middle East, the Balkans, Central Asia, North Africa and South Asia. They are traditionally located in vaulted or covered streets th ...
. The name comes from the term '' grok'', a computing
jargon Jargon, or technical language, is the specialized terminology associated with a particular field or area of activity. Jargon is normally employed in a particular Context (language use), communicative context and may not be well understood outside ...
term meaning "intuitive understanding". OpenGrok is being developed mainly by the community with the help of a few engineers from the
Oracle Corporation Oracle Corporation is an American Multinational corporation, multinational computer technology company headquartered in Austin, Texas. Co-founded in 1977 in Santa Clara, California, by Larry Ellison, who remains executive chairman, Oracle was ...
. OpenGrok is released under the terms of the Common Development and Distribution License (CDDL). It is mainly written in
Java Java is one of the Greater Sunda Islands in Indonesia. It is bordered by the Indian Ocean to the south and the Java Sea (a part of Pacific Ocean) to the north. With a population of 156.9 million people (including Madura) in mid 2024, proje ...
, with some tooling done in Python. It relies on the analysis done by Ctags. There is an official Docker image available.


Features

OpenGrok supports: * Full text search * Definition search * Identifier search * Path search * History search * Showing matching lines * Hierarchical search * Query syntax * Incremental updates * Syntax highlighting cross-references * Quick navigation inside files * Interface for SCM * Usable URLs * Individual file download * Changes at directory level * Multi language support * Suggester * REST API


See also

* LXR Cross Referencer * ViewVC *
FishEye (software) Fisheye is a revision-control browser and search engine owned by Atlassian, Inc. Although Fisheye is a commercial product, it is freely available to open source projects and non-profit institutions. In addition to the advanced search and dif ...


References


External links

*
''Open Source Development, Communities and Quality'', September 7-10, 2008

"Story-of-OpenGrok"
{{Java (Sun) Code comprehension tools Code navigation tools Cross-platform free software Free version control software Source code Java platform software Concurrent Versions System Apache Subversion Code search engines